List the connectionFields a database type accepts

What to send under connectionFields when creating a connection of this type. Reference data about the connector, not about any connection: no connection need exist, and an unknown dataBaseType responds 404 naming the types that do.

Each entry in the response is one complete set of fields that satisfies the connection - send the fields of any one set, not a mixture. There is more than one set whenever the connector offers a choice (Snowflake, for instance, authenticates by password or by key pair): a field of type choice carries the value that its set fixes, and must be sent with that value.

Fields marked sensitive: true are secrets. They are accepted on POST /direct_connections and never returned by any read, but an update preserves any secret whose key it does not send - so a spec read back from GET can be sent straight to PUT. Send a sensitive field on update only to change it; sending it empty clears it. Requires the api:read scope.

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

The connector type, as sent on create - e.g. 'postgresql', 'snowflake', 'bigquery', 'dbt'. Matched case-insensitively.

Responses

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