Skip to content
Brokerium

Create a topic

POST
/api/v1/clusters/{id}/topics
curl --request POST \
  --url http://localhost:8080/api/v1/clusters/example/topics \
  --header 'Content-Type: application/json' \
  --header 'X-Brokerium-Request: 1' \
  --cookie brokerium_session=<brokerium_session> \
  --data '{ "name": "example", "partitions": 1, "replicationFactor": 1, "configs": { "additionalProperty": "example" } }'

Role: operator. Partitions and replication factor default to the broker defaults when 0.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
X-Brokerium-Request
required
string
Allowed value: 1

Required on every non-GET request.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
partitions
integer format: int32
replicationFactor
integer format: int16
configs
object
key
additional properties
string

Example generated

{
  "name": "example",
  "partitions": 1,
  "replicationFactor": 1,
  "configs": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

201

Section titled “201”

Created.

Media typeapplication/json
object
topic
string
id
string

Example generated

{
  "topic": "example",
  "id": "example"
}

400

Section titled “400”

Error.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.