Skip to content
Brokerium

Topic with configs and partition offsets

GET
/api/v1/clusters/{id}/topics/{topic}
curl --request GET \
  --url http://localhost:8080/api/v1/clusters/example/topics/example \
  --cookie brokerium_session=<brokerium_session>

Role: viewer.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
topic
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Topic detail.

Media typeapplication/json
object
topic
object
name
string
id
string
internal
boolean
replicationFactor
integer
minInsyncReplicas
integer
configs
object
key
additional properties
string
sizeBytes
integer format: int64
partitions
Array<object>
object
id
integer format: int32
leader
integer format: int32
leaderEpoch
integer format: int32
replicas
Array<integer>
isr
Array<integer>
offline
Array<integer> | null
sizeBytes
integer format: int64
replicaBytes
object | null
error
string
error
string
configs
Array<object>
object
name
string
value
string
source
string
sensitive
boolean
offsets

Start and end offsets keyed by partition id.

object
key
additional properties
object
start
integer format: int64
end
integer format: int64

Example generated

{
  "topic": {
    "name": "example",
    "id": "example",
    "internal": true,
    "replicationFactor": 1,
    "minInsyncReplicas": 1,
    "configs": {
      "additionalProperty": "example"
    },
    "sizeBytes": 1,
    "partitions": [
      {
        "id": 1,
        "leader": 1,
        "leaderEpoch": 1,
        "replicas": [
          1
        ],
        "isr": [
          1
        ],
        "offline": [
          1
        ],
        "sizeBytes": 1,
        "replicaBytes": "example",
        "error": "example"
      }
    ],
    "error": "example"
  },
  "configs": [
    {
      "name": "example",
      "value": "example",
      "source": "example",
      "sensitive": true
    }
  ],
  "offsets": {
    "additionalProperty": {
      "start": 1,
      "end": 1
    }
  }
}

404

Section titled “404”

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.