Sign in
web_backend

Create a connection

Changed on
post/v1/web_backend/connections/create

Request

  • Base URL: http://localhost:8000/api
  • URL: http://localhost:8000/api/v1/web_backend/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
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
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.

operationIdsOperationId[]
latestSyncJobCreatedAtinteger

epoch time of the latest sync job. null if no sync job has taken place.

latestSyncJobStatus'pending' | 'running' | 'incomplete' | 'failed' | 'succeeded' | 'cancelled'
isSyncingboolean required
catalogIdstring uuid

Example response

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

Changes

  • 9065466a1781Revision changes
    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property ///// to the response with the status

  • dc8fde994af0Revision changes
    • info

      added the optional property to the response with the status