Ctrlk
ProductsDownload Community Edition
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Kafka Connect

List all connectors

get

Returns a list of all connectors, optionally filtered by cluster and connector class name

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Query parameters
clusterstring[]Optional
classNamestring[]Optional
Responses
200Success
application/json
get/api/v1/environments/{environment}/proxy/api/kafka-connect/connectors
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/connectors HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "name": "text",
      "lrn": "text",
      "cluster": "text",
      "state": "RUNNING",
      "tasks": [
        {
          "id": 1,
          "state": "RUNNING"
        }
      ],
      "className": "text",
      "type": "text",
      "author": "text",
      "icon": "text"
    }
  ]
}

Create a new connector

post

Creates a new connector with the specified configuration

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestring · min: 1Required
clusterstring · min: 1Required
Responses
201Success
application/json
objectOptional
post/api/v1/environments/{environment}/proxy/api/kafka-connect/connectors
POST /api/v1/environments/{environment}/proxy/api/kafka-connect/connectors HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "name": "connector",
  "cluster": "cluster",
  "configuration": {
    "connector.class": "org...FileStreamSinkConnector"
  }
}
{}

Get connector details

get

Returns detailed information about a specific connector including its configuration, status, and tasks

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Responses
200Success
application/json
namestringRequired
lrnstringRequired
statestring · enumOptionalPossible values:
typestringOptional
classNamestringOptional
workerIdstringOptional
versionstringOptional
authorstringOptional
iconstringOptional
clusterstringRequired
codestringOptional
get/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "lrn": "text",
  "state": "RUNNING",
  "type": "text",
  "className": "text",
  "workerId": "text",
  "version": "text",
  "author": "text",
  "icon": "text",
  "cluster": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "tasks": [
    {
      "id": "text",
      "state": "text",
      "workerId": "text",
      "trace": "text"
    }
  ],
  "code": "text",
  "__errors": [
    {
      "field": "text",
      "reason": "text"
    }
  ]
}

Delete a connector

delete

Deletes a connector and stops all of its tasks

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Responses
200Success
application/json
objectOptional
delete/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}
DELETE /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

List connector plugins

get

Returns a list of all connector plugins installed in the Connect cluster(s), optionally filtered by cluster

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Query parameters
clusterstring[]Optional
Responses
200Success
application/json
get/api/v1/environments/{environment}/proxy/api/kafka-connect/plugins
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/plugins HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "class": "text",
      "cluster": "text",
      "name": "text",
      "type": "text",
      "version": "text",
      "author": "text",
      "icon": "text",
      "description": "text",
      "docs": "text"
    }
  ]
}

Update connector state

put

Updates the state of a connector. Supported actions: start, stop, restart, pause, resume

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
actionstring · enumRequiredPossible values:
Responses
200Success
application/json
objectOptional
put/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/{action}
PUT /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/{action} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Restart a connector task

put

Restarts a specific task of a connector by task ID

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
p1integerRequired
Responses
200Success
application/json
objectOptional
put/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/tasks/{p1}/restart
PUT /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/tasks/{p1}/restart HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Validate connector configuration

post

Validates a connector configuration without creating the connector

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestringRequired
clusterstringRequired
Responses
200Success
application/json
classstringRequired
post/api/v1/environments/{environment}/proxy/api/kafka-connect/validate
POST /api/v1/environments/{environment}/proxy/api/kafka-connect/validate HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "name": "connector",
  "cluster": "cluster",
  "configuration": {
    "connector.class": "org...FileStreamSinkConnector"
  }
}
{
  "class": "text",
  "configuration": [
    {
      "name": "text",
      "required": true,
      "order": 1,
      "documentation": "text",
      "errors": [
        "text"
      ],
      "visible": true,
      "value": "text",
      "defaultValue": "text"
    }
  ]
}

Get connector topics

get

Returns a list of topic names that a connector has been using since its creation or since the last time its set of active topics was reset. Returns an empty list for connectors that don't have active topics or non-existent connectors

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Responses
200Success
application/json
string[]Optional
get/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/topics
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/topics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

Get Connect cluster information

get

Returns information about the Connect cluster including version and name

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
Responses
200Success
application/json
namestringRequired
versionstringRequired
get/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/info
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/info HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "version": "text"
}

Get connector offsets

get

Retrieves the offsets for a connector. For source connectors, returns connector-defined source partitions and offsets. For sink connectors, returns Kafka topic/partition and offset information.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Responses
200Success
application/json
get/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/offsets
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/offsets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "offsets": [
    {
      "partition": null,
      "offset": null
    }
  ]
}

Reset connector offsets

delete

Resets/deletes the offsets for a connector. The connector must be in the STOPPED state. This completely removes the connector's offset data.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Responses
200Success
application/json
messagestringRequired
delete/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/offsets
DELETE /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/offsets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text"
}

Alter connector offsets

patch

Alters the offsets for a connector. The connector must be in the STOPPED state. The request body uses the same format as the GET response, allowing you to retrieve offsets, modify them, and submit them back.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Body
Responses
200Success
application/json
messagestringRequired
patch/api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/offsets
PATCH /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/offsets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "offsets": [
    {
      "partition": null,
      "offset": null
    }
  ]
}
{
  "message": "text"
}
PreviousAs CodeNextAdministration

Last updated

Was this helpful?