Apache Airflow · JSON Structure

Airflow Connection Body Structure

Connection Serializer for requests body.

Type: object Properties: 10 Required: 2
Workflow OrchestrationData PipelineOpen SourceApacheDAGSchedulingETLData Engineering

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

Properties

connection_id conn_type description host login schema port password extra team_name

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/airflow/refs/heads/main/json-structure/airflow-connection-body-structure.json",
  "name": "ConnectionBody",
  "description": "Connection Serializer for requests body.",
  "type": "object",
  "properties": {
    "connection_id": {
      "type": "string",
      "maxLength": 200,
      "pattern": "^[\\w.-]+$",
      "title": "Connection Id"
    },
    "conn_type": {
      "type": "string",
      "title": "Conn Type"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "host": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Host"
    },
    "login": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Login"
    },
    "schema": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Schema"
    },
    "port": {
      "anyOf": [
        {
          "type": "int32"
        },
        {
          "type": "null"
        }
      ],
      "title": "Port"
    },
    "password": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Password"
    },
    "extra": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Extra"
    },
    "team_name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 50
        },
        {
          "type": "null"
        }
      ],
      "title": "Team Name"
    }
  },
  "required": [
    "connection_id",
    "conn_type"
  ],
  "additionalProperties": false
}