Create a new topic.
POST /admin/topics
Create a new topic.
Request
Request Body
topic_create_request
The details of the topic to be created.
name
string
The name of topic to be created.
partitions
integer
The number of partitions.
partition_count
integer
The number of partitions, this field takes precedence over 'partitions'. Default value is 1 if not specified.
configs
array
The config properties to be set for the new topic.
Response
202 - The request was accepted.
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
422 - The request was semantically invalid. Consult the error information returned in the response body for details.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get a list of topics.
GET /admin/topics
Returns a list containing information about all of the Kafka topics that are defined for an instance of the Event Streams service. If there are currently no topics defined then an empty list is returned.
Request
Path Parameters
Query Parameters
topic_filter
string
A filter to be applied to the topic names. A simple filter can be specified as a string with asterisk (``) wildcards representing 0 or more characters, e.g. `topic-name` will filter all topic names that begin with the string `topic-name` followed by any character sequence. A more complex filter pattern can be used by surrounding a regular expression in forward slash (`/`) delimiters, e.g. `/topic-name.* /`.
per_page
integer
The number of topic names to be returned.
page
integer
The page number to be returned. The number 1 represents the first page. The default value is 1.
Response
200 - Returns a list of topics.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get detailed information on a topic.
GET /admin/topics/{topic_name}
Get detailed information on a topic.
Request
Path Parameters
topic_name
Required *
string
The topic name for the topic to be described.
Query Parameters
Response
200 - Returns a detailed description of a single topic.
name
string
The name of the topic.
partitions
integer
The number of partitions.
replicationFactor
integer
The number of replication factor.
retentionMs
integer
The value of config property 'retention.ms'.
cleanupPolicy
string
The value of config property 'cleanup.policy'.
configs
topic_configs
replicaAssignments
array
The replia assignment of the topic.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested topic was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Delete a topic.
DELETE /admin/topics/{topic_name}
Delete a topic.
Request
Path Parameters
topic_name
Required *
string
The topic name for the topic to be deleted.
Query Parameters
Response
202 - The request was accepted.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested topic was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Increase the number of partitions and/or update one or more topic configuration parameters.
PATCH /admin/topics/{topic_name}
Increase the number of partitions and/or update one or more topic configuration parameters.
Request
Request Body
topic_update_request
The details of the topic to be updated.
new_total_partition_count
integer
The new partition number to be increased to.
configs
array
The config properties to be updated for the topic. Valid config names are 'cleanup.policy', 'retention.ms', 'retention.bytes', 'segment.bytes', 'segment.ms', 'segment.index.bytes'.
Path Parameters
topic_name
Required *
string
The topic name for the topic to be updated.
Query Parameters
Response
202 - The request was accepted.
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested topic was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
422 - The request was semantically invalid. Consult the error information returned in the response body for details.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Delete records before the given offset on a topic.
DELETE /admin/topics/{topic_name}/records
Delete records before the given offset on a topic.
Request
Request Body
record_delete_request
The records in which partition and before which offset to be deleted.
records_to_delete
array
Path Parameters
topic_name
Required *
string
The topic name of the records to be deleted.
Query Parameters
Response
202 - The request was accepted.
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested topic or partition or offset was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
422 - The request was semantically invalid. Consult the error information returned in the response body for details.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Create a new quota.
POST /admin/quotas/{entity_name}
Create a new quota.
Request
Request Body
quota_detail
The new quota to be created.
producer_byte_rate
integer
The producer byte rate quota value.
consumer_byte_rate
integer
The consumer byte rate quota value.
Path Parameters
entity_name
Required *
string
The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
Query Parameters
Response
202 - The request was accepted.
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
422 - The request was semantically invalid. Consult the error information returned in the response body for details.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Update a quota.
PATCH /admin/quotas/{entity_name}
Update an entity's quota.
Request
Request Body
quota_detail
The new quota to be updated.
producer_byte_rate
integer
The producer byte rate quota value.
consumer_byte_rate
integer
The consumer byte rate quota value.
Path Parameters
entity_name
Required *
string
The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
Query Parameters
Response
202 - The request was accepted.
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested quota was not found for specified entity.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
422 - The request was semantically invalid. Consult the error information returned in the response body for details.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Delete a quota.
DELETE /admin/quotas/{entity_name}
Delete an entity's quota.
Request
Path Parameters
entity_name
Required *
string
The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
Query Parameters
Response
202 - The request was accepted.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested quota was not found for specified entity.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get quota information for an entity.
GET /admin/quotas/{entity_name}
Get quota information for an entity.
Request
Path Parameters
entity_name
Required *
string
The entity name of the quotas can be `default` or an IAM Service ID that starts with an `iam-ServiceId` prefix.
Query Parameters
Response
200 - Returns the quota information for the entity.
producer_byte_rate
integer
The producer byte rate quota value.
consumer_byte_rate
integer
The consumer byte rate quota value.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested entity was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
List each entity's quota information.
GET /admin/quotas
List each entity's quota information.
Request
Response
200 - Returns a list of entity's quota information.
data
array
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get a list of brokers in the cluster.
GET /admin/brokers
Get a list of brokers in the cluster.
Request
Response
200 - Returns a list of brokers in the cluster.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get detailed information for a single broker.
GET /admin/brokers/{broker_id}
Get detailed information for a single broker.
Request
Path Parameters
broker_id
Required *
integer
The broker ID of the broker to be described.
Query Parameters
Response
200 - Returns detailed information for a single broker.
id
integer
The ID of the broker configured in the 'broker.id' broker config property.
host
string
The hostname that the broker is listening on and which is configured in the 'advertised.listeners' broker config property.
port
integer
The port that the broker is listening on and which is configured in the 'advertised.listeners' broker config property.
rack
string
The rack of the broker used in rack aware replication assignment for fault tolerance. It is configure in the 'broker.rack' broker config property.
configs
array
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested broker was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get all configuration parameters for a single broker.
GET /admin/brokers/{broker_id}/configs
Get all configuration parameters for a single broker.
Request
Path Parameters
broker_id
Required *
integer
The broker ID of the broker to be described.
Query Parameters
config_filter
string
A filter to be applied to the config names. A simple filter can be specified as a string with asterisk (``) wildcards representing 0 or more characters, e.g. `file` will filter all config names that begin with the string `file` followed by any character sequence. A more complex filter pattern can be used by surrounding a regular expression in forward slash (`/`) delimiters, e.g. `/file.* /`.
verbose
boolean
When true, all information about the config properties is returned including the source of the configuration indicating its scope and whether it's dynamic.
Response
200 - Returns the detailed configuration parameters of the broker.
id
integer
The ID of the broker configured in the 'broker.id' broker config property.
host
string
The hostname that the broker is listening on and which is configured in the 'advertised.listeners' broker config property.
port
integer
The port that the broker is listening on and which is configured in the 'advertised.listeners' broker config property.
rack
string
The rack of the broker used in rack aware replication assignment for fault tolerance. It is configure in the 'broker.rack' broker config property.
configs
array
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested broker was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get information about the cluster.
GET /admin/cluster
Get information about the cluster.
Request
Response
200 - Returns a description of the cluster and its brokers.
id
string
The ID of the cluster.
controller
broker_summary
brokers
array
List of brokers in the cluster.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get a list of consumer group IDs.
GET /admin/consumergroups
Get a list of consumer group IDs.
Request
Path Parameters
Query Parameters
group_filter
string
A filter to be applied to the consumer group IDs. A simple filter can be specified as a string with asterisk (``) wildcards representing 0 or more characters, e.g. `group_id` will filter all group IDs that begin with the string `group_id` followed by any character sequence. A more complex filter pattern can be used by surrounding a regular expression in forward slash (`/`) delimiters, e.g. `/group_id.* /`.
per_page
integer
The number of consumer groups to be returned.
page
integer
The page number to be returned. The number 1 represents the first page. The default value is 1.
Response
200 - Returns a list of consumer groups.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get detailed information on a consumer group.
GET /admin/consumergroups/{group_id}
Get detailed information on a consumer group.
Request
Path Parameters
group_id
Required *
string
The group ID for the consumer group to be described.
Query Parameters
Response
200 - Returns detailed information of a consumer group.
group_id
string
The ID of the consumer group.
state
string
THe state of the consumer group.
members
array
Members in the consumer group.
offsets
array
The offsets of the consumer group.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested consumer group was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Delete a consumer group.
DELETE /admin/consumergroups/{group_id}
Delete a consumer group.
Request
Path Parameters
group_id
Required *
string
The group ID for the consumer group to be deleted.
Query Parameters
Response
202 - The request was accepted.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested consumer group was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Update the offsets of a consumer group.
PATCH /admin/consumergroups/{group_id}
Update the offsets of a consumer group using various modes, eg. latest, earliest, datetime,etc.
Request
Request Body
group_reset_request
The offsets of the consumer group to be reset.
topic
string
The name of the topic to be reset. If missing or blank, the operation applies to all topics read by the consumer group.
mode
string
Mode of shift operation. Valid values are 'earliest', 'latest', 'datetime'.
value
string
Value for resetting offsets, based on 'mode=datetime', omit for 'earliest' and 'latest'.
execute
boolean
Whether to execute the operation of resetting the offsets.
Path Parameters
group_id
Required *
string
The group ID for the consumer group to be updated.
Query Parameters
Response
200 - The result of updating the offsets for the group. When 'execute' is true, this is the actual state of the group. When 'execute' is false, it is the projected state as if the operation had been actually performed.
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
404 - The requested consumer group was not found.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get current topic selection for mirroring.
GET /admin/mirroring/topic-selection
Get current topic selection for mirroring.
Request
Response
200 - Returns topic selections as patterns.
includes
array
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Replace topic selection for mirroring.
POST /admin/mirroring/topic-selection
Replace topic selection for mirroring. This operation replaces the complete set of mirroring topic selections.
Request
Request Body
mirroring_topic_selection
Topic selection patterns for mirroring.
includes
array
Response
200 - Returns new topic selections as patterns.
includes
array
400 - The request body was invalid JSON.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
415 - The header 'Content-Type' must be 'application/json'.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get topics that are being actively mirrored.
GET /admin/mirroring/active-topics
Get topics that are being actively mirrored.
Request
Response
200 - Return topics that are being actively mirrored.
active_topics
array
401 - The client was not authenticated to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
403 - The client was not authorized to perform this request.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
503 - The server was not available.
error_code
integer
The 3-digits http status code plus 2-digits kafka error code.
message
string
The error message.
incident_id
string
The incident ID of the error.
Get the status of the instance.
GET /admin/status
Get the status of the instance.
Request
Response
200 - Returns the status of the instance.
status
string
The status of the instance: * `available` - the instance is functioning as expected * `degraded` - the instance is in a degraded state, some operations may not complete successfully * `offline` - the instance is offline, all operations attempted against the instance will fail * `unknown` - the state of the instance is not known at this time