Skip to content
Brokerium

Cluster with its latest snapshot

GET
/api/v1/clusters/{id}
curl --request GET \
  --url 'http://localhost:8080/api/v1/clusters/example?fresh=1' \
  --cookie brokerium_session=<brokerium_session>

Role: viewer. fresh=1 collects a new snapshot before answering.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Query Parameters

Section titled “Query Parameters”
fresh
string
Allowed values: 1

Responses

Section titled “Responses”

200

Section titled “200”

Cluster view.

Media typeapplication/json
object
cluster
required
object
id
required
string
name
required
string
provider
required
string
Allowed values: external agent docker strimzi
flavor
required
string
Allowed values: apache msk confluent-cloud aiven
bootstrapServers
required
Array<string>
security
required
object
protocol
required
string
Allowed values: PLAINTEXT SSL SASL_PLAINTEXT SASL_SSL
saslMechanism
string
Allowed values: "" PLAIN SCRAM-SHA-256 SCRAM-SHA-512 AWS_MSK_IAM OAUTHBEARER
username
string
tlsServerName
string
tlsInsecureSkipVerify
boolean
tlsCaCertPem
string
awsRegion
string
labels
object
key
additional properties
string
settings

Provider settings, for example Kafka version and port base of Docker clusters.

object
kafkaClusterId
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
health
required
object
status
string
Allowed values: ok warning critical unreachable unknown
issues
Array<object>
object
severity
required
string
Allowed values: critical warning info
code
required
string
message
required
string
brokers
integer
brokersAlive
integer
brokersFenced
integer
brokersCordoned
integer
topics
integer
partitions
integer
offlinePartitions
integer
underReplicated
integer
underMinIsr
integer
atMinIsr
integer
reassigning
integer
quorumLeader
integer
voters
integer
votersLagging
integer
diskUsedPercentMax
number
metadataVersion
string
kraftVersion
integer
capabilities
required

Actions available for this cluster; the dashboard shows only these.

object
manageTopics
boolean
manageConfigs
boolean
manageAcls
boolean
manageScram
boolean
manageQuotas
boolean
manageGroups
boolean
browseMessages
boolean
reassign
boolean
electLeaders
boolean
cordon
boolean
unregisterBrokers
boolean
describeQuorum
boolean
removeVoters
boolean
addControllers
boolean
provisionNodes
boolean
restartNodes
boolean
upgradeVersion
boolean
finalizeFeatures
boolean
migrateQuorum
boolean
scaleNodePools
boolean
notes
Array<string>
error
string
updatedAt
required
string format: date-time
snapshot
object
collectedAt
string format: date-time
durationMs
integer format: int64
clusterId
string
brokers
Array<object>
object
id
integer format: int32
host
string
port
integer
rack
string
fenced
boolean
alive
boolean
cordoned
boolean
logDirs
Array<object> | null
object
path
string
totalBytes
integer format: int64
usableBytes
integer format: int64
dataBytes
integer format: int64
cordoned
boolean
error
string
diskTotalBytes
integer format: int64
diskUsableBytes
integer format: int64
dataBytes
integer format: int64
replicas
integer
leaders
integer
preferredLeaders
integer
quorum
object
leaderId
integer
leaderEpoch
integer
highWatermark
integer format: int64
voters
Array<object>
object
nodeId
integer
directoryId
string
role
string
Allowed values: leader follower observer
logEndOffset
integer format: int64
lag
integer format: int64
lastFetchTimestamp
integer format: int64
lastCaughtUpTimestamp
integer format: int64
endpoints
Array<object>
object
name
string
host
string
port
integer
observers
Array<object>
object
nodeId
integer
directoryId
string
role
string
Allowed values: leader follower observer
logEndOffset
integer format: int64
lag
integer format: int64
lastFetchTimestamp
integer format: int64
lastCaughtUpTimestamp
integer format: int64
endpoints
Array<object>
object
name
string
host
string
port
integer
features
Array<object>
object
name
string
finalized
integer
supportedMin
integer
supportedMax
integer
topics
Array<object>
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
reassignments
Array<object>
object
topic
string
partition
integer format: int32
replicas
Array<integer>
adding
Array<integer> | null
removing
Array<integer> | null
groups
Array<object>
object
id
string
type

Consumer, classic, share or streams

string
state
string
protocolType
string
members
integer
lag
integer format: int64
topics
Array<string> | null
error
string
errors
Array<string>

Example 

{
  "cluster": {
    "provider": "external",
    "flavor": "apache",
    "security": {
      "protocol": "PLAINTEXT",
      "saslMechanism": ""
    }
  },
  "health": {
    "status": "ok",
    "issues": [
      {
        "severity": "critical"
      }
    ]
  },
  "snapshot": {
    "quorum": {
      "voters": [
        {
          "role": "leader"
        }
      ],
      "observers": [
        {
          "role": "leader"
        }
      ]
    }
  }
}

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.