Kafka Connectors

get

Fetches the current target definition for a connector

Path parameters

connect-cluster-namestringRequiredExample: cluster

connector-namestringRequiredExample: connector

Responses

200Success

application/yaml

string · binaryOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{name}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector/{connector-name}

GET /api/v1/environments/{name}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector/{connector-name} HTTP/1.1
Accept: */*

binary

get

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Query parameters

clusterstring[]Optional

classNamestring[]Optional

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{name}/proxy/api/kafka-connect/connectors

GET /api/api/v1/environments/{name}/proxy/api/kafka-connect/connectors HTTP/1.1
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"
    }
  ]
}

post

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Body

namestring · min: 1Required

clusterstring · min: 1Required

Responses

200Success

application/json

objectOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{name}/proxy/api/kafka-connect/connectors

POST /api/api/v1/environments/{name}/proxy/api/kafka-connect/connectors HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

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

{}

put

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

clusterstring · min: 1Required

connectorstring · min: 1Required

actionstring · enumRequiredPossible values:

Responses

200Success

application/json

objectOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{name}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/{action}

PUT /api/api/v1/environments/{name}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/{action} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

put

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

clusterstring · min: 1Required

connectorstring · min: 1Required

p1integerRequired

Responses

200Success

application/json

objectOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put/api/v1/environments/{name}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/tasks/{p1}/restart

PUT /api/api/v1/environments/{name}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}/tasks/{p1}/restart HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

delete

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

clusterstring · min: 1Required

connectorstring · min: 1Required

Responses

200Success

application/json

objectOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete/api/v1/environments/{name}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector}

DELETE /api/api/v1/environments/{name}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

post

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Body

namestringRequired

clusterstringRequired

Responses

200Success

application/json

classstringRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{name}/proxy/api/kafka-connect/validate

POST /api/api/v1/environments/{name}/proxy/api/kafka-connect/validate HTTP/1.1
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"
    }
  ]
}