Airbyte · JSON Structure

Airbyte Connection Response Structure

Provides details of a single connection.

Type: object Properties: 15 Required: 10

Data IntegrationETLELTOpen SourceData PipelineConnectorsData

ConnectionResponse is a JSON Structure definition published by Airbyte, describing 15 properties, of which 10 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

connectionId name sourceId destinationId workspaceId status schedule nonBreakingSchemaUpdatesBehavior namespaceDefinition namespaceFormat prefix configurations createdAt tags statusReason

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/json-structure/airbyte-connection-response-structure.json",
  "name": "ConnectionResponse",
  "description": "Provides details of a single connection.",
  "type": "object",
  "properties": {
    "connectionId": {
      "format": "UUID",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "sourceId": {
      "format": "UUID",
      "type": "string"
    },
    "destinationId": {
      "format": "UUID",
      "type": "string"
    },
    "workspaceId": {
      "format": "UUID",
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/ConnectionStatusEnum"
    },
    "schedule": {
      "$ref": "#/components/schemas/ConnectionScheduleResponse"
    },
    "nonBreakingSchemaUpdatesBehavior": {
      "$ref": "#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum"
    },
    "namespaceDefinition": {
      "$ref": "#/components/schemas/NamespaceDefinitionEnum"
    },
    "namespaceFormat": {
      "type": "string"
    },
    "prefix": {
      "type": "string"
    },
    "configurations": {
      "$ref": "#/components/schemas/StreamConfigurations"
    },
    "createdAt": {
      "type": "int64"
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Tag"
      }
    },
    "statusReason": {
      "type": "string"
    }
  },
  "required": [
    "connectionId",
    "name",
    "sourceId",
    "destinationId",
    "workspaceId",
    "status",
    "schedule",
    "configurations",
    "createdAt",
    "tags"
  ]
}