AIairbytehq
public_connections
public
Connections

Get Connection details

Changed on
get/connections/{connectionId}

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/connections/{connectionId}
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: /applications/token

Response

Get a Connection by the id in the path.

connectionIdstring UUID required
namestring required
sourceIdstring UUID required
destinationIdstring UUID required
workspaceIdstring UUID required
status'active' | 'inactive' | 'deprecated' | 'locked' required
nonBreakingSchemaUpdatesBehavior'ignore' | 'disable_connection' | 'propagate_columns' | 'propagate_fully'

Set how Airbyte handles syncs when it detects a non-breaking schema change in the source

notifySchemaChangesboolean

Turns schema change notifications on or off for this connection. The workspace's notification settings decide where they are sent. Breaking changes use connectionUpdateActionRequired. Other schema changes use connectionUpdate.

namespaceDefinition'source' | 'destination' | 'custom_format'

Define the location where the data will be stored in the destination

namespaceFormatstring
prefixstring
createdAtinteger required
statusReasonstring

Changes

  • 16d3d680cfffRevision changes
    • info

      added the optional property to the response with the status

  • 5e3520798637Revision changes
    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      the /// response's property format changed from no format to set for status

    • warning

      added the new field-filtering enum value to the ///// response property for the response status

    • warning

      added the new locked enum value to the response property for the response status

    • info

      added the optional property to the response with the status