Sign in
connection

Search connections

Changed on
post/v1/connections/search

Request

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

Request body

connectionIdstring 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.

sourceIdstring uuid
destinationIdstring 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

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

Response

Successful operation

Example response

{
  "connections": [
    {
      "namespaceFormat": "${SOURCE_NAMESPACE}"
    }
  ]
}

Changes

  • efd9d612dd6fRevision changes
    • breaking

      the request property became not nullable

  • 4d4f8c8273afRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status