Test Connection

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
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
connection_name
string
Name of connection
query
HTTP Query
Expand HTTP Query definition...
tests
string[]

Response

200: Test results

Datatype
Description
can
object
Operations the current user is able to perform on this object
connection_string
string
JDBC connection string. (only populated in the 'connect' test)
message
string
Result message of test
name
string
Name of test
status
string
Result code of test

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples