Connections
Manage connections to your data warehouses.
Credentials are write-only
Deleting a connection that is in use
Sharing
Endpoints
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
The connections. Credentials are never returned.
A data warehouse connection. Credentials are never returned — secret fields
are stripped from config.
The request is malformed or a parameter failed validation.
The token is missing, malformed or expired.
Creates a connection to a data warehouse.
The config object depends on provider_id and on the authentication
method — see the examples below. Secrets you send here are stored encrypted
and never returned by any endpoint.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
Required when privacy is shared.
The connection was created.
A data warehouse connection. Credentials are never returned — secret fields
are stripped from config.
The request is malformed or a parameter failed validation.
The token is missing, malformed or expired.
The token doesn't grant access to this resource.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
5a32a0ea-555a-48dd-aeb1-8768aae8ef1cThe connection.
A data warehouse connection. Credentials are never returned — secret fields
are stripped from config.
The token is missing, malformed or expired.
The token doesn't grant access to this resource.
The resource doesn't exist.
Updates a connection. You can't change provider_id or the authentication
method. Secrets can be omitted to keep the stored values.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
5a32a0ea-555a-48dd-aeb1-8768aae8ef1cRequired when privacy is shared, and must be omitted
otherwise.
Required when privacy is shared.
The updated connection.
A data warehouse connection. Credentials are never returned — secret fields
are stripped from config.
The request is malformed or a parameter failed validation.
The token is missing, malformed or expired.
The token doesn't grant access to this resource.
The resource doesn't exist.
Deletes a connection. Pass targetConnectionId to move its maps and
workflows to another connection of the same provider first.
An API Access Token or an OAuth Access Token, sent as
Authorization: Bearer <token>.
5a32a0ea-555a-48dd-aeb1-8768aae8ef1cThe connection was deleted.
No content
The request is malformed or a parameter failed validation.
The token is missing, malformed or expired.
The token doesn't grant access to this resource.
The resource doesn't exist.
The connection is in use by other users in your organization.
No content
Last updated
Was this helpful?
