Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-14102210128.7 KB
connection

Search connections

post/v1/connections/search

Request body

connectionIdstring uuid
destinationIdstring uuid
namestring
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.

scheduleType'manual' | 'basic' | 'cron'

determine how the schedule data should be interpreted

sourceIdstring uuid
status'active' | 'inactive' | 'deprecated'

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.

Example request

{
  "destination": {
    "connectionConfiguration": {
      "user": "charles"
    }
  },
  "namespaceFormat": "${SOURCE_NAMESPACE}",
  "source": {
    "connectionConfiguration": {
      "user": "charles"
    }
  }
}

Response

Successful operation