API Reference

Updates an existing affiliate connector.

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

Requires the AccountAdmin policy and the database_connector feature.

All body fields are optional (Optional<T>) — only the properties present in the
payload are applied, so a partial update is supported. When connection-affecting fields change,
the connection is re-tested before the update is persisted.

🔐 Required permission: AccountAdmin

🚩 Requires feature: database_connector

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

The unique identifier of the affiliate connector to update.

Body Params

The details to update for the affiliate connector.

Request body for updating an affiliate database connector. Every field is an
Infrastructure.Core.Optionals.Optional`1 — only the properties present in the payload are applied, so the
request supports partial updates.

boolean

Enables or disables the connector.

string
enum

Supported external database engines for affiliate connectors.

Allowed:
string

Hostname or IP address of the external database server.

int32

TCP port the external database listens on.

string

Name of the target database/catalog.

string

Schema into which the mirror tables are created.

string

Username used to authenticate against the external database.

string

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