Skip to content
Brokerium

All clusters with health and capabilities

GET
/api/v1/overview
curl --request GET \
  --url http://localhost:8080/api/v1/overview \
  --cookie brokerium_session=<brokerium_session>

Role: viewer. Same payload as GET /api/v1/clusters.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Clusters with health and capabilities.

Media typeapplication/json
object
clusters
Array<object>
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

Example 

{
  "clusters": [
    {
      "cluster": {
        "provider": "external",
        "flavor": "apache",
        "security": {
          "protocol": "PLAINTEXT",
          "saslMechanism": ""
        }
      },
      "health": {
        "status": "ok",
        "issues": [
          {
            "severity": "critical"
          }
        ]
      }
    }
  ]
}

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.