Connections > Kafka Connect
APIs for managing connections that use the KafkaConnect template.
DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.
Returns the list of available connections
The bearer token can be obtained by creating a ServiceAccount.
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"name": "text",
"lrn": "text",
"templateName": "text",
"templateVersion": 1,
"tags": [
"text"
],
"deletable": true
}
]Adds a new connection
The bearer token can be obtained by creating a ServiceAccount.
Name of the connection
the-connectionThe request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 787
{
"name": "the-connection",
"tags": [
"text"
],
"configurationObject": {
"workers": [
"http://connect1:8083"
],
"aes256Key": "password",
"username": "user",
"password": "password",
"sslKeystore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslKeystorePassword": "password",
"sslKeyPassword": "password",
"sslTruststore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslTruststorePassword": "password",
"sslAlgorithm": "text",
"metricsType": "JMX",
"metricsPort": 9581,
"metricsSsl": true,
"metricsUsername": "username",
"metricsPassword": "password",
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
}
}{
"name": "the-connection"
}Adds a new connection V2
The bearer token can be obtained by creating a ServiceAccount.
Name of the connection
the-connectionThe request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/KafkaConnect/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 901
{
"name": "the-connection",
"tags": [
"text"
],
"configuration": {
"workers": [
"http://connect1:8083"
],
"aes256Key": {
"value": "password"
},
"username": "user",
"password": {
"value": "password"
},
"sslKeystore": {
"value": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"sslKeystorePassword": {
"value": "password"
},
"sslKeyPassword": {
"value": "password"
},
"sslTruststore": {
"value": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"sslTruststorePassword": {
"value": "password"
},
"sslAlgorithm": {
"value": "text"
},
"metricsType": {
"value": "JMX"
},
"metricsPort": 9581,
"metricsSsl": {
"value": true
},
"metricsUsername": "username",
"metricsPassword": {
"value": "password"
},
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"value": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
}
}{
"name": "the-connection"
}Validates the connection
The bearer token can be obtained by creating a ServiceAccount.
Name of the connection
the-connectiontrue if testing an update to an existing connection, false if testing a new connection
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 785
{
"name": "the-connection",
"configurationObject": {
"workers": [
"http://connect1:8083"
],
"aes256Key": "password",
"username": "user",
"password": "password",
"sslKeystore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslKeystorePassword": "password",
"sslKeyPassword": "password",
"sslTruststore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslTruststorePassword": "password",
"sslAlgorithm": "text",
"metricsType": "JMX",
"metricsPort": 9581,
"metricsSsl": true,
"metricsUsername": "username",
"metricsPassword": "password",
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
},
"update": true
}No content
Validates the connection V2
The bearer token can be obtained by creating a ServiceAccount.
Name of the connection
the-connectiontrue if testing an update to an existing connection, false if testing a new connection
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/KafkaConnect/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 899
{
"name": "the-connection",
"configuration": {
"workers": [
"http://connect1:8083"
],
"aes256Key": {
"value": "password"
},
"username": "user",
"password": {
"value": "password"
},
"sslKeystore": {
"value": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"sslKeystorePassword": {
"value": "password"
},
"sslKeyPassword": {
"value": "password"
},
"sslTruststore": {
"value": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"sslTruststorePassword": {
"value": "password"
},
"sslAlgorithm": {
"value": "text"
},
"metricsType": {
"value": "JMX"
},
"metricsPort": 9581,
"metricsSsl": {
"value": true
},
"metricsUsername": "username",
"metricsPassword": {
"value": "password"
},
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"value": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
},
"update": true
}No content
Returns the connection details
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
An internal server error has occurred
GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "the-connection",
"lrn": "text",
"templateVersion": 1,
"templateName": "Kafka",
"builtIn": true,
"createdBy": "text",
"createdAt": 1,
"modifiedBy": "text",
"modifiedAt": 1,
"configurationObject": {
"workers": [
"http://connect1:8083"
],
"aes256Key": "password",
"username": "user",
"password": "password",
"sslKeystore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslKeystorePassword": "password",
"sslKeyPassword": "password",
"sslTruststore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslTruststorePassword": "password",
"sslAlgorithm": "text",
"metricsType": "JMX",
"metricsPort": 9581,
"metricsSsl": true,
"metricsUsername": "username",
"metricsPassword": "password",
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
},
"tags": [
"text"
],
"deletable": true
}Updates the connection details
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
The supplied identifier is already being used by another resource
An internal server error has occurred
PUT /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 763
{
"tags": [
"text"
],
"configurationObject": {
"workers": [
"http://connect1:8083"
],
"aes256Key": "password",
"username": "user",
"password": "password",
"sslKeystore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslKeystorePassword": "password",
"sslKeyPassword": "password",
"sslTruststore": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
},
"sslTruststorePassword": "password",
"sslAlgorithm": "text",
"metricsType": "JMX",
"metricsPort": 9581,
"metricsSsl": true,
"metricsUsername": "username",
"metricsPassword": "password",
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
}
}{
"name": "the-connection"
}Deletes the connection
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
No content
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
The supplied identifier is already being used by another resource
An internal server error has occurred
DELETE /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/KafkaConnect/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Updates the connection details V2
The bearer token can be obtained by creating a ServiceAccount.
The name of the connection
The request input was invalid
Authentication error
The purchased Lenses license does not provide access to this feature
Authorisation error
The requested resource cannot be found
The supplied identifier is already being used by another resource
An internal server error has occurred
PUT /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/KafkaConnect/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 877
{
"tags": [
"text"
],
"configuration": {
"workers": [
"http://connect1:8083"
],
"aes256Key": {
"value": "password"
},
"username": "user",
"password": {
"value": "password"
},
"sslKeystore": {
"value": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"sslKeystorePassword": {
"value": "password"
},
"sslKeyPassword": {
"value": "password"
},
"sslTruststore": {
"value": {
"fileId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"sslTruststorePassword": {
"value": "password"
},
"sslAlgorithm": {
"value": "text"
},
"metricsType": {
"value": "JMX"
},
"metricsPort": 9581,
"metricsSsl": {
"value": true
},
"metricsUsername": "username",
"metricsPassword": {
"value": "password"
},
"metricsHttpSuffix": "/jolokia",
"metricsHttpTimeout": 5000,
"metricsCustomUrlMappings": {
"http://connect1:8083": "connect1_jmx:9584"
},
"metricsCustomPortMappings": {
"value": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"metricsRateLimitingMaxRetries": 5,
"metricsRateLimitingBackoff": 30000
}
}{
"name": "the-connection"
}Last updated
Was this helpful?