Kafka Topic

Operations related to Kafka topics.

Get a list of Kafka topics

Retrieve a list of Kafka topics currently in the given cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
Responses
200

Successfully returned a JSON list of Kafka topics

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

get/provisioning/v1/{clusterId}/kafka/topics
Request samples
Response samples
application/json
{
  • "topics": [
    ]
}

Create a Kafka topic

Create a new Kafka topic in the given cluster with the specified number of partitions and replication factor.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
Request Body schema: application/json
topic
string
replicationFactor
integer <int32>
partitions
integer <int32>
Responses
201

Kafka topic successfully created

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

post/provisioning/v1/{clusterId}/kafka/topics
Request samples
application/json
{
  • "topic": "topic-test",
  • "replicationFactor": 3,
  • "partitions": 3
}
Response samples
application/json
{
  • "message": "Topic test-topic created."
}

Get the information of a Kafka topic

Retrieve the information (number of partitions and replication factor) of a Kafka topic in the given cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
topic
required
string
Responses
200

Successfully returned a JSON of Kafka topic information

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

get/provisioning/v1/{clusterId}/kafka/topics/{topic}
Request samples
Response samples
application/json
{
  • "topic": "test-topic",
  • "partitions": 3,
  • "replicationFactor": 3
}

Delete a Kafka topic

Delete the Kafka topic for a given topic name

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
topic
required
string
Responses
200

Kafka topic successfully deleted

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

delete/provisioning/v1/{clusterId}/kafka/topics/{topic}
Request samples
Response samples
application/json
{
  • "message": "Kafka topic test-topic has been deleted."
}

Describe the configs of a Kafka topic

Describe the configs of a Kafka topic.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
topic
required
string
Responses
200

Successfully returned a JSON of a Kafka topic configs

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

get/provisioning/v1/{clusterId}/kafka/topics/{topic}/config
Request samples
Response samples
application/json
{
  • "topic": "test-topic",
  • "config": {
    }
}

Modify the configs of a Kafka topic

Modify the configs of a Kafka topic. Refer to https://kafka.apache.org/23/documentation.html for available keys and valid values.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Example: 64223f17-7c9b-4986-8e2e-a44a91a26635
topic
required
string
Request Body schema: application/json
object
Responses
200

Successfully updated the configs of Kafka topic

400

Bad Request

401

Not Authorized

403

Missing permissions

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

put/provisioning/v1/{clusterId}/kafka/topics/{topic}/config
Request samples
application/json
{
  • "config": {
    }
}
Response samples
application/json
{
  • "message": "The configs for Kafka topic test-topic has been modified."
}