Read a Connector
GET/connect/v1/environments/:environment_id/clusters/:kafka_cluster_id/connectors/:connector_name
Get information about the connector.
Request
Responses
- 200
- 401
- 404
- 429
- 500
Connector.
Unauthorized
Not Found
Rate Limit Exceeded
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
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
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Internal Server Error
OpenAPI definition (YAML)
paths:
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}:
get:
x-lifecycle-stage: General Availability
operationId: readConnectv1Connector
description: '[](#section/Versioning/API-Lifecycle-Policy)
Get information about the connector.'
tags:
- Connectors (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: Name of the connector
config:
type: object
description: 'Configuration parameters for the connector. These configurations
are the minimum set of key-value pairs (KVP) which can be used to
define how the connector connects Kafka to the external system.
Some of these KVPs are common to all the connectors, such as
connection parameters to Kafka, connector metadata, etc. The list
of common connector configurations is as follows
- cloud.environment
- cloud.provider
- connector.class
- kafka.api.key
- kafka.api.secret
- kafka.endpoint
- kafka.region
- name
A specific connector such as `GcsSink` would have additional
parameters 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.
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
title: connect.v1.Connector
example:
name: MyGcsLogsBucketConnector
config:
cloud.environment: prod
cloud.provider: aws
connector.class: GcsSink
data.format: BYTES
flush.size: '1000'
gcs.bucket.name: APILogsBucket
gcs.credentials.config: '****************'
kafka.api.key: '****************'
kafka.api.secret: '****************'
kafka.endpoint: SASL_SSL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092
kafka.region: us-west-2
name: MyGcsLogsBucketConnector
tasks.max: '1'
time.interval: DAILY
topics: APILogsTopic
tasks:
- connector: MyGcsLogsBucketConnector
task: 0
type: sink
'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