Version 4.0.24.16 (latest)
Test an existing connection.
Note that a connection's 'dialect' property has a 'connection_tests' property that lists the specific types of tests that the connection supports.
This API is rate limited.
Unsupported tests in the request will be ignored.
Request
PUT
/connections/{connection_name}/test
Datatype
Description
Request
path
Expand HTTP Path definition...
connection_name
Name of connection
query
Expand HTTP Query definition...
tests
Response
200: Test results
Datatype
Description
(array)
can
lock
Operations the current user is able to perform on this object
connection_string
lock
JDBC connection string. (only populated in the 'connect' test)
message
lock
Result message of test
name
lock
Name of test
status
lock
Result code of test
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Python
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/test_connection.py |
TypeScript
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/typescript/testDBConnections.ts |