AIairbytehq
public_connections
public
Connections

Create a connection

Changed on
post/connections

Request

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

Request body

namestring

Optional name of the connection

sourceIdstring uuid required
destinationIdstring uuid required
dataResidencystring
namespaceDefinition'source' | 'destination' | 'custom_format'

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

namespaceFormatstring

Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.

prefixstring

Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).

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. If omitted, it is true when the workspace's connectionUpdate settings have email or webhook enabled. Otherwise it is false.

status'active' | 'inactive' | 'deprecated' | 'locked'

Response

Successful operation

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 new optional request property

    • info

      added the optional property to the response with the status

  • 1ab9ff46c57aRevision changes
    • info

      added the new optional request property /