Retrieve the Zeebe cluster status

GET /status

Retrieves the Topology of a Zeebe cluster from the Gateway. This provides insights into the current status of the cluster

Responses

successfully retrieved

application/json

Schema
Example (from schema)

Schema

data object
A topology for a Zeebe cluster
clusterSize int32
The expected number of brokers (nodes) in the cluster
partitionsCount int32
The number of partitions spread across the cluster
replicationFactor int32
The number of replicas that should exist of each partition.
gatewayVersion string
The version of the gateway's software
brokers object[]
The list of brokers that are part of the cluster
Array [
address string
The address of the broker (host:port)
host string
The hostname of the broker
port int32
The port at which the broker can be contacted
version string
The version of the broker's software
partitions object[]
The list of partitions managed or replicated on this broker
Array [
partitionId int32
The unique (within a cluster) ID of the partition
role string
Possible values: [LEADER, FOLLOWER, INACTIVE]
The RAFT role of the broker for the partition
leader boolean
Whether the broker is leader for the partition, or not
health string
Possible values: [HEALTHY, UNHEALTHY, DEAD]
The health of the partition on the broker
]
nodeId int32
The unique (within the cluster) ID for the broker
]
error string

{
  "data": {
    "clusterSize": 0,
    "partitionsCount": 0,
    "replicationFactor": 0,
    "gatewayVersion": "string",
    "brokers": [
      {
        "address": "string",
        "host": "string",
        "port": 0,
        "version": "string",
        "partitions": [
          {
            "partitionId": 0,
            "role": "LEADER",
            "leader": true,
            "health": "HEALTHY"
          }
        ],
        "nodeId": 0
      }
    ]
  },
  "error": "string"
}