API Reference

Tests connectivity for an ad-hoc set of database connection details.

post
https://platform.routy.app/api/v1/affiliates/connectors/test-connection

Requires the AccountAdmin policy and the database_connector feature.

Validates a candidate connection without persisting a connector — typically used by the UI
before creating one. Opens a connection using the supplied engine
(PostgresSQL or SqlServer), host, credentials and SSL settings, and verifies
CREATE TABLE permission. An unknown engine or a failed check is reported as a 400.

🔐 Required permission: AccountAdmin

🚩 Requires feature: database_connector

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request containing connection details to be tested.

Request body for testing an ad-hoc set of database connection details without persisting a
connector.

string
enum

Supported external database engines for affiliate connectors.

Allowed:
string | null

Hostname or IP address of the external database server.

int32

TCP port the external database listens on.

string | null

Name of the target database/catalog.

string | null

Optional schema used when verifying permissions.

string | null

Username used to authenticate against the external database.

string | null

Password used to authenticate against the external database.

boolean

Whether the connection must use SSL/TLS.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago