Sign in
connection

Update a connection

Changed on
post/v1/connections/update

Request

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

Request body

connectionIdstring uuid required
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'.

namestring

Name that will be set to this connection

prefixstring

Prefix that will be prepended to the name of each stream when it is written to the destination.

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
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 response

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

Changes

  • efd9d612dd6fRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property //// became not nullable

    • 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

    • info

      the request property became nullable

    • info

      the request property //// became nullable

    • info

      the request property //// became nullable