Create a connection

post

https://api.airbyte.com/v1/connections

Body Params

name

string

Optional name of the connection

sourceId

uuid

required

destinationId

uuid

required

configurations

object

A list of configured stream options for a connection.

schedule

object

schedule for when the the connection should run, per the schedule type

dataResidency

string

enum

Defaults to auto

Allowed:

namespaceDefinition

string

enum

Defaults to destination

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

Allowed:

namespaceFormat

string

Defaults to null

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

prefix

string

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

string

enum

Defaults to ignore

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

Allowed:

status

string

enum

Allowed:

Responses

400

Invalid data

403

Not allowed

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation