API Reference

Creates a new affiliate database connector.

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

Requires the AccountAdmin policy and the database_connector feature.

Supply the target database coordinates (engine, host, port, database,
optional schema, username, password, useSsl). engine accepts
PostgresSQL or SqlServer. On success the Location header points at the new
connector and the body carries its identifier.

🔐 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 details of the affiliate connector to be created.

Request body for creating a new affiliate database connector.

int32 | null

The affiliate the connector belongs to.

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 into which the mirror tables are created.

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