Kafka
Fetch Kafka Access Control Lists
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/acl HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"resourceType": "text",
"resourceName": "text",
"patternType": "text",
"principal": "text",
"permissionType": "text",
"host": "text",
"operation": "text",
"lrn": "text"
}
]Create or update a Kafka Access Control List
The bearer token can be obtained by creating a ServiceAccount.
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
PUT /api/v1/environments/{environment}/proxy/api/acl HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 162
{
"resourceType": "Topic",
"resourceName": "trades",
"patternType": "LITERAL",
"principal": "User:Alice",
"permissionType": "Allow",
"host": "example.com",
"operation": "Read"
}No content
Remove a Kafka Access Control List
The bearer token can be obtained by creating a ServiceAccount.
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
DELETE /api/v1/environments/{environment}/proxy/api/acl HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 250
{
"resourceType": "Topic",
"resourceName": "trades",
"patternType": "LITERAL",
"principal": "User:Alice",
"permissionType": "Allow",
"host": "example.com",
"operation": "Read",
"lrn": "kafka:acl:${Environment}/kafka/${AclResourceType}/${PrincipalType}/${Principal}"
}No content
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/quotas HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"entityType": "USERCLIENT",
"entityName": "text",
"child": "text",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"url": "text",
"lrn": "text",
"isAuthorized": true
}
]The bearer token can be obtained by creating a ServiceAccount.
The user to create the quota for
janeNo 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
PUT /api/v1/environments/{environment}/proxy/api/quotas/users/{username} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"producer_byte_rate": "100000",
"consumer_byte_rate": "200000",
"request_percentage": "75"
}No content
The bearer token can be obtained by creating a ServiceAccount.
The user to delete the quota for
janeNo 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
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users/{username} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
[
"producer_byte_rate",
"consumer_byte_rate",
"request_percentage"
]No content
The bearer token can be obtained by creating a ServiceAccount.
The client id to create the quota for
app1No 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
PUT /api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"producer_byte_rate": "100000",
"consumer_byte_rate": "200000",
"request_percentage": "75"
}No content
The bearer token can be obtained by creating a ServiceAccount.
The client id to create the quota for
app1No 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
DELETE /api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
[
"producer_byte_rate",
"consumer_byte_rate",
"request_percentage"
]No content
The bearer token can be obtained by creating a ServiceAccount.
The user to delete the quota for
janeNo 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
PUT /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"producer_byte_rate": "100000",
"consumer_byte_rate": "200000",
"request_percentage": "75"
}No content
The bearer token can be obtained by creating a ServiceAccount.
The user to delete the quota for
janeNo 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
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
[
"producer_byte_rate",
"consumer_byte_rate",
"request_percentage"
]No content
The bearer token can be obtained by creating a ServiceAccount.
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
PUT /api/v1/environments/{environment}/proxy/api/quotas/users HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"producer_byte_rate": "100000",
"consumer_byte_rate": "200000",
"request_percentage": "75"
}No content
The bearer token can be obtained by creating a ServiceAccount.
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
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
[
"producer_byte_rate",
"consumer_byte_rate",
"request_percentage"
]No content
The bearer token can be obtained by creating a ServiceAccount.
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
PUT /api/v1/environments/{environment}/proxy/api/quotas/clients HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"producer_byte_rate": "100000",
"consumer_byte_rate": "200000",
"request_percentage": "75"
}No content
The bearer token can be obtained by creating a ServiceAccount.
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
DELETE /api/v1/environments/{environment}/proxy/api/quotas/clients HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
[
"producer_byte_rate",
"consumer_byte_rate",
"request_percentage"
]No content
The bearer token can be obtained by creating a ServiceAccount.
The user to delete the quota for
janeThe client id to create the quota for
app1No 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
PUT /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"producer_byte_rate": "100000",
"consumer_byte_rate": "200000",
"request_percentage": "75"
}No content
The bearer token can be obtained by creating a ServiceAccount.
The user to delete the quota for
janeThe client id to create the quota for
app1No 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
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
[
"producer_byte_rate",
"consumer_byte_rate",
"request_percentage"
]No content
The bearer token can be obtained by creating a ServiceAccount.
The topic name
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/topics/{topic}/brokerConfigs HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"name": "text",
"value": "text",
"isDefault": true,
"isSensitive": true,
"isReadOnly": true
}
]The bearer token can be obtained by creating a ServiceAccount.
The topic name
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
PUT /api/v1/environments/{environment}/proxy/api/configs/topics/{topic} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"configs": [
{
"key": "text",
"value": "text"
}
]
}textRetrieve information about a given topic
The bearer token can be obtained by creating a ServiceAccount.
Name of the topic
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/topics/{p1} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"topicName": "text",
"lrn": "text",
"partitions": 1,
"replication": 1,
"isControlTopic": true,
"isCompacted": true,
"keyType": "text",
"valueType": "text",
"totalMessages": 1,
"config": [
{
"name": "text",
"value": "text",
"isDefault": true,
"defaultValue": "text",
"documentation": "text",
"originalValue": "text"
}
],
"consumers": [
{
"id": "text",
"lrn": "text",
"coordinator": {
"id": 1,
"host": "text",
"port": 1,
"rack": "text"
},
"active": true,
"state": "Unknown",
"consumers": [
"text"
],
"consumersCount": 1,
"topicPartitionsCount": 1,
"minLag": 1,
"maxLag": 1,
"application": {
"id": "text",
"lrn": "text",
"name": "text",
"type": "AkkaStreams",
"cluster": "text",
"namespace": "text"
},
"coverage": "full"
}
],
"messagesPerPartition": [
{
"partition": 1,
"messages": 1,
"begin": 1,
"end": 1
}
],
"messagesPerSecond": 1,
"isMarkedForDeletion": true,
"timestamp": 1,
"keySchema": "text",
"keySchemaVersion": 1,
"keySchemaInlined": "text",
"valueSchema": "text",
"valueSchemaVersion": 1,
"valueSchemaInlined": "text",
"description": "text",
"tags": [
{
"name": "text"
}
],
"backups": [
{
"id": 1,
"createdAt": "2025-11-15T14:32:43.765Z",
"topic": "text",
"connectCluster": "text",
"connectorName": "text",
"connectorVersion": "text",
"s3Location": "text",
"reference": "text"
}
],
"restores": [
{
"id": 1,
"createdAt": "2025-11-15T14:32:43.765Z",
"topic": "text",
"connectCluster": "text",
"connectorName": "text",
"connectorVersion": "text",
"s3Location": "text",
"reference": "text"
}
],
"coverage": "full"
}Retrieve a given topic partition details
The bearer token can be obtained by creating a ServiceAccount.
Name of the topic
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/topics/{p1}/partitions HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"partition": 1,
"leader": 1,
"preferredLeader": 1,
"replicas": [
{
"broker": 1,
"leader": true,
"inSync": true
}
]
}
]Retrieve information about all topics
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/topics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"topicName": "text",
"lrn": "text",
"partitions": 1,
"replication": 1,
"isControlTopic": true,
"isCompacted": true,
"keyType": "text",
"valueType": "text",
"totalMessages": 1,
"config": [
{
"name": "text",
"value": "text",
"isDefault": true,
"defaultValue": "text",
"documentation": "text",
"originalValue": "text"
}
],
"consumers": [
{
"id": "text",
"lrn": "text",
"coordinator": {
"id": 1,
"host": "text",
"port": 1,
"rack": "text"
},
"active": true,
"state": "Unknown",
"consumers": [
"text"
],
"consumersCount": 1,
"topicPartitionsCount": 1,
"minLag": 1,
"maxLag": 1,
"application": {
"id": "text",
"lrn": "text",
"name": "text",
"type": "AkkaStreams",
"cluster": "text",
"namespace": "text"
},
"coverage": "full"
}
],
"messagesPerPartition": [
{
"partition": 1,
"messages": 1,
"begin": 1,
"end": 1
}
],
"messagesPerSecond": 1,
"isMarkedForDeletion": true,
"timestamp": 1,
"keySchema": "text",
"keySchemaVersion": 1,
"keySchemaInlined": "text",
"valueSchema": "text",
"valueSchemaVersion": 1,
"valueSchemaInlined": "text",
"description": "text",
"tags": [
{
"name": "text"
}
],
"backups": [
{
"id": 1,
"createdAt": "2025-11-15T14:32:43.765Z",
"topic": "text",
"connectCluster": "text",
"connectorName": "text",
"connectorVersion": "text",
"s3Location": "text",
"reference": "text"
}
],
"restores": [
{
"id": 1,
"createdAt": "2025-11-15T14:32:43.765Z",
"topic": "text",
"connectCluster": "text",
"connectorName": "text",
"connectorVersion": "text",
"s3Location": "text",
"reference": "text"
}
],
"coverage": "full"
}
]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
POST /api/v1/environments/{environment}/proxy/api/topics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96
{
"topicName": "text",
"replication": 1,
"partitions": 1,
"configs": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}textRetrieve information about partitions of a given topic
The bearer token can be obtained by creating a ServiceAccount.
Name of the topic
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/v2/topics/{topic}/partitions HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"partitions": [
{
"partition": 1,
"leader": 1,
"preferredLeader": 1,
"messages": 1,
"begin": 1,
"end": 1,
"bytes": 1,
"replicas": [
{
"broker": 1,
"leader": true,
"inSync": true
}
]
}
],
"jmxLastRetrievedAt": "2025-11-15T14:32:43.765Z"
}Resend a kafka message
The bearer token can be obtained by creating a ServiceAccount.
Name of the topic
Kafka partition
Kafka offset
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
PUT /api/v1/environments/{environment}/proxy/api/topics/{topic}/{partition}/{offset}/resend HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"partition": 1,
"offset": 1
}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
PUT /api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topicName}/partitions HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"partitions": 1
}{
"partitions": 1
}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
DELETE /api/v1/environments/{environment}/proxy/api/topics/{topicName}/{partition}/{offset} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textThe 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
DELETE /api/v1/environments/{environment}/proxy/api/topics/{topicName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textDeprecated. To fetch Kafka topic details, please, use (listDatasets) /api/v1/datasets.
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/kafka/topics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"topicName": "text",
"lrn": "text",
"partitions": 1,
"replication": 1,
"isControlTopic": true,
"keyType": "text",
"valueType": "text",
"totalMessages": 1,
"configs": 1,
"consumers": 1,
"messagesPerSecond": 1,
"isMarkedForDeletion": true,
"isCompacted": true,
"description": "text",
"tags": [
{
"name": "text"
}
],
"size": 1
}
]Deprecated. To fetch Kafka topic details, please, use (listDatasets) /api/v1/datasets.
The bearer token can be obtained by creating a ServiceAccount.
The page number to be returned, must be greater than zero. Defaults to 1.
1The elements amount on a single page, must be greater than zero.
25The field to sort results by
Sorting order. Defaults to ascending
Filter by topic name
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/v2/kafka/topics?pageSize=1 HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"topics": [
{
"topicName": "text",
"lrn": "text",
"partitions": 1,
"replication": 1,
"isControlTopic": true,
"keyType": "text",
"valueType": "text",
"totalMessages": 1,
"configs": 1,
"consumers": 1,
"messagesPerSecond": 1,
"isMarkedForDeletion": true,
"isCompacted": true,
"description": "text",
"tags": [
{
"name": "text"
}
],
"size": 1
}
],
"pageCount": 1,
"totalTopicCount": 1
}Returns a Kafka topic short summary
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/v2/kafka/topics/{topicName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"topicName": "text",
"lrn": "text",
"partitions": 1,
"replication": 1,
"isControlTopic": true,
"keyType": "text",
"valueType": "text",
"totalMessages": 1,
"configs": 1,
"consumers": 1,
"messagesPerSecond": 1,
"isMarkedForDeletion": true,
"isCompacted": true,
"description": "text",
"tags": [
{
"name": "text"
}
],
"size": 1
}Returns the schema associated with the topic key payload.
The bearer token can be obtained by creating a ServiceAccount.
The Kafka topic name
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/kafka/topics/{topic}/schema/key HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"schema": "text",
"version": 1,
"inlinedSchema": "text"
}Returns the schema associated with the topic value payload.
The bearer token can be obtained by creating a ServiceAccount.
The Kafka topic name
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/kafka/topics/{topic}/schema/value HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"schema": "text",
"version": 1,
"inlinedSchema": "text"
}For AVRO, JSON, CSV, and XML it is required to provide a schema, but not for primitives (INT, LONG, STRING, BYTES), custom Lenses serde or formats like SW*** and TW***. When using AVRO the schema will be registered with the Schema Registry and the process will fail if that step fails.
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
POST /api/v1/environments/{environment}/proxy/api/v1/kafka/topic HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188
{
"name": "text",
"replication": 1,
"partitions": 1,
"configs": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"format": {
"key": {
"format": "TWAVRO",
"schema": "text"
},
"value": {
"format": "TWAVRO",
"schema": "text"
}
}
}No content
Back up a topic to S3. You must configure the bucket, optional prefix and the flush settings.
The bearer token can be obtained by creating a ServiceAccount.
The topic name
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/kafka/topic/{topic}/backup HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"cluster": "text",
"s3": {
"bucket": "text",
"prefix": "text"
},
"flush": {
"count": 1,
"size": 1,
"interval": 1
}
}{
"id": 1,
"connector": "text",
"cluster": "text"
}Restores data from S3 into the target topic.
The bearer token can be obtained by creating a ServiceAccount.
The topic name
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/kafka/topic/{topic}/restore HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"cluster": "text",
"s3": {
"bucket": "text",
"prefix": "text"
},
"storageFormat": "avro"
}{
"id": 1,
"connector": "text",
"cluster": "text"
}The bearer token can be obtained by creating a ServiceAccount.
Kafka Topic name
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/metadata/topics/{topicName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"topicName": "text",
"lrn": "text",
"keyType": "text",
"valueType": "text",
"keySchema": "text",
"keySchemaVersion": 1,
"keySchemaInlined": "text",
"valueSchema": "text",
"valueSchemaVersion": 1,
"valueSchemaInlined": "text",
"description": "text",
"tags": [
"text"
],
"additionalInfo": null,
"coverage": "full"
}The bearer token can be obtained by creating a ServiceAccount.
The topic name
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
DELETE /api/v1/environments/{environment}/proxy/api/metadata/topics/{topicName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
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/metadata/topics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"topicName": "text",
"lrn": "text",
"keyType": "text",
"valueType": "text",
"keySchema": "text",
"keySchemaVersion": 1,
"keySchemaInlined": "text",
"valueSchema": "text",
"valueSchemaVersion": 1,
"valueSchemaInlined": "text",
"description": "text",
"tags": [
"text"
],
"additionalInfo": null,
"coverage": "full"
}
]The bearer token can be obtained by creating a ServiceAccount.
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/metadata/topics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"topicName": "text",
"keyType": "text",
"valueType": "text",
"keySchema": "text",
"keySchemaVersion": 1,
"keySchemaInlined": "text",
"valueSchema": "text",
"valueSchemaVersion": 1,
"valueSchemaInlined": "text",
"description": "text",
"tags": [
"text"
],
"additionalInfo": null
}No content
Fetches the configured topic creation policy. A default one will be returned if no one exists
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/kafka/topic/policy HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"config": {
"partitions": {
"min": 1,
"max": 1
},
"replication": {
"min": 1,
"max": 1
},
"retention": {
"size": {
"default": 1,
"max": 1
},
"time": {
"default": 1,
"max": 1
}
}
},
"naming": {
"pattern": "text",
"description": "text"
},
"isApplicable": true
}Sets the topic creation policy
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
PUT /api/v1/environments/{environment}/proxy/api/v1/kafka/topic/policy HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"config": {
"partitions": {
"min": 1
},
"replication": {
"min": 1
},
"retention": {
"size": {
"max": -1
},
"time": {
"max": -1
}
}
},
"naming": {
"pattern": "(prd|stg|dev)-.*",
"description": "Env prefixed topic name"
}
}No content
Returns the list of Kafka consumer groups
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/consumers HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "text",
"lrn": "text",
"coordinator": {
"id": 1,
"host": "text",
"port": 1,
"rack": "text"
},
"active": true,
"state": "Unknown",
"consumers": [
"text"
],
"consumersCount": 1,
"topicPartitionsCount": 1,
"minLag": 1,
"maxLag": 1,
"application": {
"id": "text",
"lrn": "text",
"name": "text",
"type": "AkkaStreams",
"cluster": "text",
"namespace": "text"
},
"coverage": "full"
}
]Returns the consumer groups which are using the given topic
The bearer token can be obtained by creating a ServiceAccount.
The topic name
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/consumers/{topic} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "text",
"lrn": "text",
"coordinator": {
"id": 1,
"host": "text",
"port": 1,
"rack": "text"
},
"active": true,
"state": "Unknown",
"consumers": [
"text"
],
"consumersCount": 1,
"topicPartitionsCount": 1,
"minLag": 1,
"maxLag": 1,
"application": {
"id": "text",
"lrn": "text",
"name": "text",
"type": "AkkaStreams",
"cluster": "text",
"namespace": "text"
},
"coverage": "full"
}
]Updates the offset for a topic-partition for the given group
The bearer token can be obtained by creating a ServiceAccount.
The consumer group id
The topic name
The topic partition number
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
PUT /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12
{
"offset": 1
}No content
Update the offset for a consumer group topic-partition tuples
The bearer token can be obtained by creating a ServiceAccount.
The consumer group id
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
PUT /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"topics": [
"text"
]
}No content
Returns the consumer groups which are using the given topic
The bearer token can be obtained by creating a ServiceAccount.
The consumer group name
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
DELETE /api/v1/environments/{environment}/proxy/api/consumers/{consumerGroupName} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete the offset for a topic-partition for the given group
The bearer token can be obtained by creating a ServiceAccount.
The consumer group id
The topic name
The topic partition number
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
DELETE /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete the offset for a consumer group topic-partition tuples
The bearer token can be obtained by creating a ServiceAccount.
The consumer group id
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/consumers/{groupId}/offsets/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"topics": [
"text"
]
}No content
Last updated
Was this helpful?