Kafka Connect

get
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: 
Accept: */*
{
  "data": [
    {
      "name": "text",
      "lrn": "text",
      "cluster": "text",
      "state": "RUNNING",
      "tasks": [
        {
          "id": 1,
          "state": "RUNNING"
        }
      ],
      "className": "text",
      "type": "text",
      "author": "text",
      "icon": "text"
    }
  ]
}
post
Path parameters
environmentstringRequired
Body
namestring · min: 1Required
clusterstring · min: 1Required
Responses
200Success
application/json
Responseobject
post
/api/v1/environments/{environment}/proxy/api/kafka-connect/connectors
POST /api/v1/environments/{environment}/proxy/api/kafka-connect/connectors HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "name": "connector",
  "cluster": "cluster",
  "configuration": {
    "connector.class": "org...FileStreamSinkConnector"
  }
}
{}
get
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}
GET /api/v1/environments/{environment}/proxy/api/kafka-connect/clusters/{cluster}/connectors/{connector} HTTP/1.1
Host: 
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
Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
Responses
200Success
application/json
Responseobject
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: 
Accept: */*
{}
get
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: 
Accept: */*
{
  "data": [
    {
      "class": "text",
      "cluster": "text",
      "name": "text",
      "type": "text",
      "version": "text",
      "author": "text",
      "icon": "text",
      "description": "text",
      "docs": "text"
    }
  ]
}
put
Path parameters
environmentstringRequired
clusterstring · min: 1Required
connectorstring · min: 1Required
actionstring · enumRequiredPossible values:
Responses
200Success
application/json
Responseobject
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: 
Accept: */*
{}
post
Path parameters
environmentstringRequired
Body
namestringRequired
clusterstringRequired
Responses
200Success
application/json
post
/api/v1/environments/{environment}/proxy/api/kafka-connect/validate
POST /api/v1/environments/{environment}/proxy/api/kafka-connect/validate HTTP/1.1
Host: 
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"
    }
  ]
}

Last updated

Was this helpful?