Data IntegrationETLELTOpen-SourceData PipelineConnectorsData
ConnectionCreateRequest is a JSON Structure definition published by Airbyte, describing 12 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/json-structure/airbyte-connection-create-request-structure.json",
"name": "ConnectionCreateRequest",
"description": "ConnectionCreateRequest schema from Airbyte API",
"type": "object",
"properties": {
"name": {
"description": "Optional name of the connection",
"type": "string"
},
"sourceId": {
"type": "uuid"
},
"destinationId": {
"type": "uuid"
},
"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"
}
}
},
"required": [
"sourceId",
"destinationId"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.