ProductsDownload Community Edition

Kafka

get

Fetch Kafka Access Control Lists

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/acl
GET /api/v1/environments/{environment}/proxy/api/acl HTTP/1.1
Host: 
Accept: */*

[
  {
    "resourceType": "text",
    "resourceName": "text",
    "patternType": "text",
    "principal": "text",
    "permissionType": "text",
    "host": "text",
    "operation": "text",
    "lrn": "text"
  }
]
put

Create or update a Kafka Access Control List

Path parameters
environmentstringRequired
Body
resourceTypestringRequired
resourceNamestringRequired
patternTypestringOptional
principalstringRequired
permissionTypestringRequired
hoststringRequired
operationstringRequired
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/acl
PUT /api/v1/environments/{environment}/proxy/api/acl HTTP/1.1
Host: 
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
delete

Remove a Kafka Access Control List

Path parameters
environmentstringRequired
Body
resourceTypestringRequired
resourceNamestringRequired
patternTypestringOptional
principalstringRequired
permissionTypestringRequired
hoststringRequired
operationstringRequired
lrnstringRequired
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/acl
DELETE /api/v1/environments/{environment}/proxy/api/acl HTTP/1.1
Host: 
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
get
Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/quotas
GET /api/v1/environments/{environment}/proxy/api/quotas HTTP/1.1
Host: 
Accept: */*

[
  {
    "entityType": "USERCLIENT",
    "entityName": "text",
    "child": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "url": "text",
    "lrn": "text",
    "isAuthorized": true
  }
]
put
Path parameters
environmentstringRequired
usernamestringRequired

The user to create the quota for

Example: jane
Body
Other propertiesstringOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/quotas/users/{username}
PUT /api/v1/environments/{environment}/proxy/api/quotas/users/{username} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}
No content
delete
Path parameters
environmentstringRequired
usernamestringRequired

The user to delete the quota for

Example: jane
Bodystring[]
string[]Optional
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/quotas/users/{username}
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users/{username} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]
No content
put
Path parameters
environmentstringRequired
client-idstringRequired

The client id to create the quota for

Example: app1
Body
Other propertiesstringOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id}
PUT /api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}
No content
delete
Path parameters
environmentstringRequired
client-idstringRequired

The client id to create the quota for

Example: app1
Bodystring[]
string[]Optional
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id}
DELETE /api/v1/environments/{environment}/proxy/api/quotas/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]
No content
put
Path parameters
environmentstringRequired
usernamestringRequired

The user to delete the quota for

Example: jane
Body
Other propertiesstringOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients
PUT /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}
No content
delete
Path parameters
environmentstringRequired
usernamestringRequired

The user to delete the quota for

Example: jane
Bodystring[]
string[]Optional
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]
No content
put
Path parameters
environmentstringRequired
Body
Other propertiesstringOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/quotas/users
PUT /api/v1/environments/{environment}/proxy/api/quotas/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}
No content
delete
Path parameters
environmentstringRequired
Bodystring[]
string[]Optional
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/quotas/users
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]
No content
put
Path parameters
environmentstringRequired
Body
Other propertiesstringOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/quotas/clients
PUT /api/v1/environments/{environment}/proxy/api/quotas/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}
No content
delete
Path parameters
environmentstringRequired
Bodystring[]
string[]Optional
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/quotas/clients
DELETE /api/v1/environments/{environment}/proxy/api/quotas/clients HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]
No content
put
Path parameters
environmentstringRequired
usernamestringRequired

The user to delete the quota for

Example: jane
client-idstringRequired

The client id to create the quota for

Example: app1
Body
Other propertiesstringOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id}
PUT /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "producer_byte_rate": "100000",
  "consumer_byte_rate": "200000",
  "request_percentage": "75"
}
No content
delete
Path parameters
environmentstringRequired
usernamestringRequired

The user to delete the quota for

Example: jane
client-idstringRequired

The client id to create the quota for

Example: app1
Bodystring[]
string[]Optional
Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id}
DELETE /api/v1/environments/{environment}/proxy/api/quotas/users/{username}/clients/{client-id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 64

[
  "producer_byte_rate",
  "consumer_byte_rate",
  "request_percentage"
]
No content
Deprecated
get
Path parameters
environmentstringRequired
topicstringRequired

The topic name

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/topics/{topic}/brokerConfigs
GET /api/v1/environments/{environment}/proxy/api/topics/{topic}/brokerConfigs HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "value": "text",
    "isDefault": true,
    "isSensitive": true,
    "isReadOnly": true
  }
]
put
Path parameters
environmentstringRequired
topicstringRequired

The topic name

Body
Responses
200Success
application/json
Responsestring
put
/api/v1/environments/{environment}/proxy/api/configs/topics/{topic}
PUT /api/v1/environments/{environment}/proxy/api/configs/topics/{topic} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "configs": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}
text
Deprecated
get

Retrieve information about a given topic

Path parameters
environmentstringRequired
p1stringRequired

Name of the topic

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/topics/{p1}
GET /api/v1/environments/{environment}/proxy/api/topics/{p1} HTTP/1.1
Host: 
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-10-24T16:19:20.378Z",
      "topic": "text",
      "connectCluster": "text",
      "connectorName": "text",
      "connectorVersion": "text",
      "s3Location": "text",
      "reference": "text"
    }
  ],
  "restores": [
    {
      "id": 1,
      "createdAt": "2025-10-24T16:19:20.378Z",
      "topic": "text",
      "connectCluster": "text",
      "connectorName": "text",
      "connectorVersion": "text",
      "s3Location": "text",
      "reference": "text"
    }
  ],
  "coverage": "full"
}
Deprecated
get

Retrieve a given topic partition details

Path parameters
environmentstringRequired
p1stringRequired

Name of the topic

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/topics/{p1}/partitions
GET /api/v1/environments/{environment}/proxy/api/topics/{p1}/partitions HTTP/1.1
Host: 
Accept: */*

[
  {
    "partition": 1,
    "leader": 1,
    "preferredLeader": 1,
    "replicas": [
      {
        "broker": 1,
        "leader": true,
        "inSync": true
      }
    ]
  }
]
Deprecated
get

Retrieve information about all topics

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/topics
GET /api/v1/environments/{environment}/proxy/api/topics HTTP/1.1
Host: 
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-10-24T16:19:20.378Z",
        "topic": "text",
        "connectCluster": "text",
        "connectorName": "text",
        "connectorVersion": "text",
        "s3Location": "text",
        "reference": "text"
      }
    ],
    "restores": [
      {
        "id": 1,
        "createdAt": "2025-10-24T16:19:20.378Z",
        "topic": "text",
        "connectCluster": "text",
        "connectorName": "text",
        "connectorVersion": "text",
        "s3Location": "text",
        "reference": "text"
      }
    ],
    "coverage": "full"
  }
]
post
Path parameters
environmentstringRequired
Body
topicNamestringRequired
replicationintegerOptional
partitionsintegerOptional
Responses
201Success
application/json
Responsestring
post
/api/v1/environments/{environment}/proxy/api/topics
POST /api/v1/environments/{environment}/proxy/api/topics HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "topicName": "text",
  "replication": 1,
  "partitions": 1,
  "configs": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
text
get

Retrieve information about partitions of a given topic

Path parameters
environmentstringRequired
topicstringRequired

Name of the topic

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v2/topics/{topic}/partitions
GET /api/v1/environments/{environment}/proxy/api/v2/topics/{topic}/partitions HTTP/1.1
Host: 
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-10-24T16:19:20.378Z"
}
put

Resend a kafka message

Path parameters
environmentstringRequired
topicstringRequired

Name of the topic

partitionintegerRequired

Kafka partition

offsetinteger · int64Required

Kafka offset

Responses
200Success
application/json
put
/api/v1/environments/{environment}/proxy/api/topics/{topic}/{partition}/{offset}/resend
PUT /api/v1/environments/{environment}/proxy/api/topics/{topic}/{partition}/{offset}/resend HTTP/1.1
Host: 
Accept: */*

{
  "partition": 1,
  "offset": 1
}
put
Path parameters
environmentstringRequired
topicNamestringRequired
Body
partitionsintegerRequired
Responses
200Success
application/json
put
/api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topicName}/partitions
PUT /api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topicName}/partitions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "partitions": 1
}
{
  "partitions": 1
}
delete
Path parameters
environmentstringRequired
topicNamestringRequired
partitionintegerRequired
offsetinteger · int64Required
Responses
200Success
application/json
Responsestring
delete
/api/v1/environments/{environment}/proxy/api/topics/{topicName}/{partition}/{offset}
DELETE /api/v1/environments/{environment}/proxy/api/topics/{topicName}/{partition}/{offset} HTTP/1.1
Host: 
Accept: */*

text
delete
Path parameters
environmentstringRequired
topicNamestringRequired
Responses
200Success
application/json
Responsestring
delete
/api/v1/environments/{environment}/proxy/api/topics/{topicName}
DELETE /api/v1/environments/{environment}/proxy/api/topics/{topicName} HTTP/1.1
Host: 
Accept: */*

text
Deprecated
get

Deprecated. To fetch Kafka topic details, please, use (listDatasets) /api/v1/datasets.

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/kafka/topics
GET /api/v1/environments/{environment}/proxy/api/v1/kafka/topics HTTP/1.1
Host: 
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
get

Deprecated. To fetch Kafka topic details, please, use (listDatasets) /api/v1/datasets.

Path parameters
environmentstringRequired
Query parameters
pageintegerOptional

The page number to be returned, must be greater than zero. Defaults to 1.

Example: 1
pageSizeintegerRequired

The elements amount on a single page, must be greater than zero.

Example: 25
sortBystring · enumOptional

The field to sort results by

Possible values:
sortingOrderstring · enumOptional

Sorting order. Defaults to ascending

Possible values:
namestringOptional

Filter by topic name

includeSystemTopicsbooleanOptional
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v2/kafka/topics
GET /api/v1/environments/{environment}/proxy/api/v2/kafka/topics?pageSize=1 HTTP/1.1
Host: 
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
}
get

Returns a Kafka topic short summary

Path parameters
environmentstringRequired
topicNamestringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v2/kafka/topics/{topicName}
GET /api/v1/environments/{environment}/proxy/api/v2/kafka/topics/{topicName} HTTP/1.1
Host: 
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
}
get

Returns the schema associated with the topic key payload.

Path parameters
environmentstringRequired
topicstringRequired

The Kafka topic name

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/schema/key
GET /api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/schema/key HTTP/1.1
Host: 
Accept: */*

{
  "schema": "text",
  "version": 1,
  "inlinedSchema": "text"
}
get

Returns the schema associated with the topic value payload.

Path parameters
environmentstringRequired
topicstringRequired

The Kafka topic name

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/schema/value
GET /api/v1/environments/{environment}/proxy/api/v1/kafka/topics/{topic}/schema/value HTTP/1.1
Host: 
Accept: */*

{
  "schema": "text",
  "version": 1,
  "inlinedSchema": "text"
}
post

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.

Path parameters
environmentstringRequired
Body
namestringRequired
replicationintegerOptional
partitionsintegerOptional
Responses
201Success
No content
post
/api/v1/environments/{environment}/proxy/api/v1/kafka/topic
POST /api/v1/environments/{environment}/proxy/api/v1/kafka/topic HTTP/1.1
Host: 
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
post

Back up a topic to S3. You must configure the bucket, optional prefix and the flush settings.

Path parameters
environmentstringRequired
topicstringRequired

The topic name

Body
clusterstringRequired
Responses
201Success
application/json
post
/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/backup
POST /api/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/backup HTTP/1.1
Host: 
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"
}
post

Restores data from S3 into the target topic.

Path parameters
environmentstringRequired
topicstringRequired

The topic name

Body
clusterstringRequired
storageFormatstring · enumRequiredPossible values:
Responses
201Success
application/json
post
/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/restore
POST /api/v1/environments/{environment}/proxy/api/v1/kafka/topic/{topic}/restore HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "cluster": "text",
  "s3": {
    "bucket": "text",
    "prefix": "text"
  },
  "storageFormat": "avro"
}
{
  "id": 1,
  "connector": "text",
  "cluster": "text"
}
get
Path parameters
environmentstringRequired
topicNamestringRequired

Kafka Topic name

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/metadata/topics/{topicName}
GET /api/v1/environments/{environment}/proxy/api/metadata/topics/{topicName} HTTP/1.1
Host: 
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"
}
delete
Path parameters
environmentstringRequired
topicNamestringRequired

The topic name

Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/metadata/topics/{topicName}
DELETE /api/v1/environments/{environment}/proxy/api/metadata/topics/{topicName} HTTP/1.1
Host: 
Accept: */*

No content
get
Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/metadata/topics
GET /api/v1/environments/{environment}/proxy/api/metadata/topics HTTP/1.1
Host: 
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"
  }
]
post
Path parameters
environmentstringRequired
Body
topicNamestringRequired
keyTypestringRequired
valueTypestringRequired
keySchemastringOptional
keySchemaVersionintegerOptional
keySchemaInlinedstringOptional
valueSchemastringOptional
valueSchemaVersionintegerOptional
valueSchemaInlinedstringOptional
descriptionstringOptional
tagsstring[]Optional
additionalInfoanyOptional
Responses
200Success
No content
post
/api/v1/environments/{environment}/proxy/api/v1/metadata/topics
POST /api/v1/environments/{environment}/proxy/api/v1/metadata/topics HTTP/1.1
Host: 
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
get

Fetches the configured topic creation policy. A default one will be returned if no one exists

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/policy
GET /api/v1/environments/{environment}/proxy/api/v1/kafka/topic/policy HTTP/1.1
Host: 
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
}
put

Sets the topic creation policy

Path parameters
environmentstringRequired
Body
Responses
204Success
No content
put
/api/v1/environments/{environment}/proxy/api/v1/kafka/topic/policy
PUT /api/v1/environments/{environment}/proxy/api/v1/kafka/topic/policy HTTP/1.1
Host: 
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
Deprecated
get

Returns the list of Kafka consumer groups

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/consumers
GET /api/v1/environments/{environment}/proxy/api/consumers HTTP/1.1
Host: 
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"
  }
]
Deprecated
get

Returns the consumer groups which are using the given topic

Path parameters
environmentstringRequired
topicstringRequired

The topic name

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/consumers/{topic}
GET /api/v1/environments/{environment}/proxy/api/consumers/{topic} HTTP/1.1
Host: 
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"
  }
]
put

Updates the offset for a topic-partition for the given group

Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

topicstringRequired

The topic name

partitioninteger · int64Required

The topic partition number

Body
one ofOptional
or
objectOptional
or
objectOptional
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition}
PUT /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/topics/{topic}/partitions/{partition} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "offset": 1
}
No content
put

Update the offset for a consumer group topic-partition tuples

Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

Body
one ofOptional
or
or
Responses
200Success
No content
put
/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets
PUT /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "topics": [
    "text"
  ]
}
No content
delete

Returns the consumer groups which are using the given topic

Path parameters
environmentstringRequired
consumerGroupNamestringRequired

The consumer group name

Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/consumers/{consumerGroupName}
DELETE /api/v1/environments/{environment}/proxy/api/consumers/{consumerGroupName} HTTP/1.1
Host: 
Accept: */*

No content
delete

Delete the offset for a topic-partition for the given group

Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

topicstringRequired

The topic name

partitionintegerRequired

The topic partition number

Responses
200Success
No content
delete
/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets
DELETE /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/topics/{topic}/partitions/{partition}/offsets HTTP/1.1
Host: 
Accept: */*

No content
post

Delete the offset for a consumer group topic-partition tuples

Path parameters
environmentstringRequired
groupIdstringRequired

The consumer group id

Body
topicsstring[] · min: 1Required
Responses
200Success
No content
post
/api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/delete
POST /api/v1/environments/{environment}/proxy/api/consumers/{groupId}/offsets/delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "topics": [
    "text"
  ]
}
No content
PreviousDatasetsNextSchema Registry

Last updated

Was this helpful?