As Code

Get connector resource definition

get

Fetches the current target definition for a connector

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

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/{environment}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector/{connector-name}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector/{connector-name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Get connector resource JSON schema

get

Fetches the JSON schema for a connector resource based on the connector class

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

connect-cluster-namestringRequiredExample: cluster

connector-class-namestringRequiredExample: org.apache.kafka.connect.file.FileStreamSinkConnector

Responses

200Success

application/json

objectOptional

JSON Schema representation of the configuration properties

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/{environment}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector-class/{connector-class-name}/schema

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environment}/proxy/api/v1/resource/kafka/connect/{connect-cluster-name}/connector-class/{connector-class-name}/schema HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Apply a resource spec

put

Applies a given resource spec.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/yaml

string · binaryOptional

Responses

201Success

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/{environment}/proxy/api/v1/resource

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/resource HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 8

"binary
"

No content

Apply a resource spec from files

put

Applies a given resource spec.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

multipart/form-data

string · binaryOptional

Responses

201Success

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/{environment}/proxy/api/v1/resource/resource-file-upload

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{environment}/proxy/api/v1/resource/resource-file-upload HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 8

"binary"

No content

Validate a resource spec

post

Validates a connector resource spec without creating or updating it

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

application/yaml

string · binaryOptional

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/{environment}/proxy/api/v1/resource/validate

HTTPcURLJavaScriptPython

POST /api/v1/environments/{environment}/proxy/api/v1/resource/validate HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/yaml
Accept: */*
Content-Length: 8

"binary
"

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