v1

latestOpenAPI 3.0.12026-08-04123613463.4 KB

Connections

Create a connection

This endpoint creates a connection. You can create a connection's underlying source, destination, and rules with a single call by declaring an object for any of those resources. You can reuse a source or destination by referencing their ID.

post/connections

Request body

namestring nullable

A unique name of the connection for the source

descriptionstring nullable

Description for the connection

destination_idstring nullable

ID of a destination to bind to the connection

source_idstring nullable

ID of a source to bind to the connection

Response

A single connection

idstring required

ID of the connection

namestring nullable required

Unique name of the connection for this source

full_namestring nullable required

Full name of the connection concatenated from source, connection and desitnation name

descriptionstring nullable required

Description of the connection

team_idstring required

ID of the project

disabled_atstring date-time nullable required

Date the connection was disabled

paused_atstring date-time nullable required

Date the connection was paused

updated_atstring date-time required

Date the connection was last updated

created_atstring date-time required

Date the connection was created