connect.v1.Connector

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/confluent/main/json-schema/confluent-connect-v1-connector-schema.json",
  "title": "connect.v1.Connector",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/confluent-connectors-connect-v1-api-openapi.yml#/components/schemas/connect.v1.Connector",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the connector"
    },
    "config": {
      "type": "object",
      "description": "Configuration parameters for the connector. These configurations\nare the minimum set of key-value pairs (KVP) which can be used to\ndefine how the connector connects Kafka to the external system.\nSome of these KVPs are common to all the connectors, such as\nconnection parameters to Kafka, connector metadata, etc. The list\nof common connector configurations is as follows\n\n- cloud.environment\n- cloud.provider\n- connector.class\n- kafka.api.key\n- kafka.api.secret\n- kafka.endpoint\n- kafka.region\n- name\n\nA specific connector such as `GcsSink` would have additional\nparameters such as `gcs.bucket.name`, `flush.size`, etc.",
      "required": [
        "cloud.environment",
        "cloud.provider",
        "connector.class",
        "name",
        "kafka.endpoint",
        "kafka.region",
        "kafka.api.key",
        "kafka.api.secret"
      ],
      "properties": {
        "cloud.environment": {
          "type": "string",
          "description": "The cloud environment type."
        },
        "cloud.provider": {
          "type": "string",
          "description": "The cloud service provider, e.g. aws, azure, etc.",
          "x-extensible-enum": [
            "aws",
            "azure",
            "gcp"
          ]
        },
        "connector.class": {
          "type": "string",
          "description": "The connector class name. E.g. BigQuerySink, GcsSink, etc."
        },
        "name": {
          "type": "string",
          "description": "Name or alias of the class (plugin) for this connector."
        },
        "kafka.endpoint": {
          "type": "string",
          "description": "The kafka cluster endpoint."
        },
        "kafka.region": {
          "type": "string",
          "description": "The kafka cluster region."
        },
        "kafka.api.key": {
          "type": "string",
          "description": "The kafka cluster api key."
        },
        "kafka.api.secret": {
          "type": "string",
          "description": "The kafka cluster api secret key.",
          "x-redact": true
        }
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "tasks": {
      "type": "array",
      "description": "List of active tasks generated by the connector",
      "items": {
        "type": "object",
        "properties": {
          "connector": {
            "type": "string",
            "description": "The name of the connector the task belongs to"
          },
          "task": {
            "type": "integer",
            "description": "Task ID within the connector"
          }
        },
        "required": [
          "connector",
          "task"
        ]
      }
    },
    "type": {
      "type": "string",
      "description": "Type of connector, sink or source",
      "enum": [
        "sink",
        "source"
      ]
    }
  },
  "required": [
    "name",
    "config"
  ]
}