Airbyte · Schema

ConnectionCreateRequest

Data IntegrationETLELTOpen SourceData PipelineConnectorsData

Properties

Name Type Description
name string Optional name of the connection
sourceId string
destinationId string
configurations object
schedule object
dataResidency string
namespaceDefinition object
namespaceFormat string Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix string Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”).
nonBreakingSchemaUpdatesBehavior object
status object
tags array
View JSON Schema on GitHub

JSON Schema

airbyte-connectioncreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionCreateRequest",
  "title": "ConnectionCreateRequest",
  "required": [
    "sourceId",
    "destinationId"
  ],
  "type": "object",
  "properties": {
    "name": {
      "description": "Optional name of the connection",
      "type": "string"
    },
    "sourceId": {
      "format": "uuid",
      "type": "string"
    },
    "destinationId": {
      "format": "uuid",
      "type": "string"
    },
    "configurations": {
      "$ref": "#/components/schemas/StreamConfigurations"
    },
    "schedule": {
      "$ref": "#/components/schemas/AirbyteApiConnectionSchedule"
    },
    "dataResidency": {
      "deprecated": true,
      "x-speakeasy-deprecation-message": "We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace.",
      "type": "string"
    },
    "namespaceDefinition": {
      "$ref": "#/components/schemas/NamespaceDefinitionEnum"
    },
    "namespaceFormat": {
      "type": "string",
      "description": "Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If \"${SOURCE_NAMESPACE}\" then behaves like namespaceDefinition = 'source'.",
      "default": null,
      "example": "${SOURCE_NAMESPACE}"
    },
    "prefix": {
      "type": "string",
      "description": "Prefix that will be prepended to the name of each stream when it is written to the destination (ex. \u201cairbyte_\u201d causes \u201cprojects\u201d => \u201cairbyte_projects\u201d).",
      "default": ""
    },
    "nonBreakingSchemaUpdatesBehavior": {
      "$ref": "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum"
    },
    "status": {
      "$ref": "#/components/schemas/ConnectionStatusEnum"
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Tag"
      }
    }
  },
  "x-speakeasy-entity": "Connection",
  "x-speakeasy-param-suppress-computed-diff": true,
  "x-speakeasy-component": true
}