Skip to main content

Read a Connector Status

GET 
/connect/v1/environments/:environment_id/clusters/:kafka_cluster_id/connectors/:connector_name/status

Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks.

Request​

Responses​

Connector.

OpenAPI definition (YAML) 
paths:
  /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status:
    get:
      x-lifecycle-stage: General Availability
      operationId: readConnectv1ConnectorStatus
      description: Get current status of the connector. This includes whether it is running, failed, or
        paused. Also includes which worker it is assigned to, error information if it has failed, and
        the state of all its tasks.
      tags:
      - Status (connect/v1)
      security:
      - cloud-api-key: []
      - confluent-sts-access-token: []
      responses:
        '200':
          description: Connector.
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    description: The name of the connector.
                  type:
                    type: string
                    description: Type of connector, sink or source.
                    enum:
                    - sink
                    - source
                  connector:
                    type: object
                    description: The map containing connector status.
                    required:
                    - state
                    - worker_id
                    properties:
                      state:
                        type: string
                        description: The state of the connector.
                        enum:
                        - NONE
                        - PROVISIONING
                        - RUNNING
                        - DEGRADED
                        - FAILED
                        - PAUSED
                        - DELETED
                      worker_id:
                        type: string
                        description: The worker ID of the connector.
                      trace:
                        type: string
                        description: The exception name in case of error.
                  tasks:
                    type: array
                    description: The map containing the task status.
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: The ID of task.
                        state:
                          type: string
                          description: The state of the task.
                        worker_id:
                          type: string
                          description: The worker ID of the task.
                        msg:
                          type: string
                      required:
                      - id
                      - state
                      - worker_id
                required:
                - name
                - type
                - connector
              example:
                name: MyGcsLogsBucketConnector
                connector:
                  state: PROVISIONING
                  worker_id: MyGcsLogsBucketConnector
                  trace: ''
                tasks: []
                type: source
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    description: Connector Error with error code and message.
                    properties:
                      code:
                        type: integer
                        description: Error code for the type of error
                      message:
                        type: string
                        description: Human readable error message
                title: connect.v1.ConnectorError
              example:
                error:
                  code: 401
                  message: Unauthorized
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    description: Connector Error with error code and message.
                    properties:
                      code:
                        type: integer
                        description: Error code for the type of error
                      message:
                        type: string
                        description: Human readable error message
                title: connect.v1.ConnectorError
              example:
                error:
                  code: 404
                  message: account not found
        '429':
          description: Rate Limit Exceeded
          headers:
            X-Request-Id:
              schema:
                type: string
              description: The unique identifier for the API request.
            X-RateLimit-Limit:
              schema:
                type: integer
              description: The maximum number of requests you're permitted to make per time period.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: The number of requests remaining in the current rate limit window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: "The relative time in seconds until the current rate-limit window resets. \
                \ \n  \n**Important:** This differs from Github and Twitter's same-named header which\
                \ uses UTC epoch seconds. We use relative time to avoid client/server time synchronization\
                \ issues."
            Retry-After:
              schema:
                type: integer
              description: The number of seconds to wait until the rate limit window resets. Only sent
                when the rate limit is reached.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    description: Connector Error with error code and message.
                    properties:
                      code:
                        type: integer
                        description: Error code for the type of error
                      message:
                        type: string
                        description: Human readable error message
                title: connect.v1.ConnectorError
              example:
                error:
                  code: 500
                  message: Oops, something went wrong
      parameters:
      - name: connector_name
        in: path
        schema:
          type: string
        required: true
        description: The unique name of the connector.
      - name: environment_id
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the environment this resource belongs to.
      - name: kafka_cluster_id
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier for the Kafka cluster.
      servers:
      - url: https://api.confluent.cloud
        description: Confluent Cloud API