connection

Create a connection between a source and a destination

Changed on Jun 3, 2022

post/v1/connections/create

Request

Base URL: http://localhost:8000/api
URL: http://localhost:8000/api/v1/connections/create
Auth: none required

Request body

namestring

Optional name of the connection

namespaceDefinition'source' | 'destination' | 'customformat'

Method used for computing final namespace in destination

namespaceFormatstring

Used when namespaceDefinition is 'customformat'. 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.

sourceIdstring uuid required

destinationIdstring uuid required

operationIdsOperationId[]

status'active' | 'inactive' | 'deprecated' required

Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.

sourceCatalogIdstring uuid

Example request

{
  "namespaceFormat": "${SOURCE_NAMESPACE}"
}

Response

Successful operation

connectionIdstring uuid required

namestring required