Topics
All operations require authentication.
List topicsBeta
Returns the topics of the service with their partitions, replication and retention settings.
Path parameters
Project ID
Service ID
Headers
Pagination cursor
Pagination size
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the topic
Minimum number of in-sync replicas required before a write is acknowledged
Name of the Kafka topic
Number of partitions for this topic
Replication factor for this topic
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "minimumInSyncReplicas": 0, "name": "string", "partitions": 0, "replication": 0, "retentionBytes": 0, "retentionHours": 0, "updatedAt": "2024-01-01T12:00:00Z" }]
Get a topicBeta
Returns the partitions, replication factor, minimum in-sync replicas and retention settings of the topic.
Path parameters
Project ID
Service ID
Topic ID
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the topic
Minimum number of in-sync replicas required before a write is acknowledged
Name of the Kafka topic
Number of partitions for this topic
Replication factor for this topic
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, topicId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "minimumInSyncReplicas": 0, "name": "string", "partitions": 0, "replication": 0, "retentionBytes": 0, "retentionHours": 0, "updatedAt": "2024-01-01T12:00:00Z"}
Create a topicBeta
Creates a topic. By default it has 1 partition, a replication factor of 1 and a retention of 168 hours (7 days). The replication factor must not exceed the number of brokers.
Path parameters
Project ID
Service ID
Request body (required)
Minimum number of in-sync replicas. Defaults to 1 when null.
Name of the Kafka topic
Number of partitions. Defaults to 1 when null.
Replication factor. Must not exceed the number of brokers. Defaults to 1 when null.
Maximum size in bytes retained per partition. -1 means unlimited. Defaults to -1 when null.
Maximum time in hours that messages are retained. -1 means unlimited. Defaults to 168 (7 days) when null.
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the topic
Minimum number of in-sync replicas required before a write is acknowledged
Name of the Kafka topic
Number of partitions for this topic
Replication factor for this topic
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "minimumInSyncReplicas": 0, "name": "string", "partitions": 0, "replication": 0, "retentionBytes": 0, "retentionHours": 0, "updatedAt": "2024-01-01T12:00:00Z"}
Delete a topicBeta
Permanently deletes the topic and its messages.
Path parameters
Project ID
Service ID
Topic ID
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the topic
Minimum number of in-sync replicas required before a write is acknowledged
Name of the Kafka topic
Number of partitions for this topic
Replication factor for this topic
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, topicId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "minimumInSyncReplicas": 0, "name": "string", "partitions": 0, "replication": 0, "retentionBytes": 0, "retentionHours": 0, "updatedAt": "2024-01-01T12:00:00Z"}
Update a topicBeta
Updates the partitions, replication, minimum in-sync replicas and retention of the topic. Every field is required. The number of partitions can only be increased.
Path parameters
Project ID
Service ID
Topic ID
Request body (required)
Minimum number of in-sync replicas required before a write is acknowledged
New number of partitions. Can only be increased, never decreased.
New replication factor. Must not exceed the number of brokers.
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the topic
Minimum number of in-sync replicas required before a write is acknowledged
Name of the Kafka topic
Number of partitions for this topic
Replication factor for this topic
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, topicId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "minimumInSyncReplicas": 0, "name": "string", "partitions": 0, "replication": 0, "retentionBytes": 0, "retentionHours": 0, "updatedAt": "2024-01-01T12:00:00Z"}
Partially update a topicBeta
Partially updates the partitions, replication, minimum in-sync replicas or retention of the topic. The number of partitions can only be increased.
Path parameters
Project ID
Service ID
Topic ID
Request body (required)
Minimum number of in-sync replicas required before a write is acknowledged
New number of partitions. Can only be increased, never decreased.
New replication factor. Must not exceed the number of brokers.
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Response
Hash of the resource used for concurrency control
Date at which the resource was created
Unique identifier of the topic
Minimum number of in-sync replicas required before a write is acknowledged
Name of the Kafka topic
Number of partitions for this topic
Replication factor for this topic
Maximum size in bytes retained per partition. -1 means unlimited.
Maximum time in hours that messages are retained. -1 means unlimited.
Date of the last update to the resource
Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000, topicId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "minimumInSyncReplicas": 0, "name": "string", "partitions": 0, "replication": 0, "retentionBytes": 0, "retentionHours": 0, "updatedAt": "2024-01-01T12:00:00Z"}