Zeebe · JSON Structure

Zeebe Api Topology Response Structure

TopologyResponse schema from Zeebe REST API

Type: object Properties: 5
BPMNCamundaCloud NativeDistributed SystemsJavaMicroservicesProcess AutomationWorkflow Orchestration

TopologyResponse is a JSON Structure definition published by Zeebe, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

brokers clusterSize partitionsCount replicationFactor gatewayVersion

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zeebe/refs/heads/main/json-structure/zeebe-api-topology-response-structure.json",
  "name": "TopologyResponse",
  "description": "TopologyResponse schema from Zeebe REST API",
  "type": "object",
  "properties": {
    "brokers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "nodeId": {
            "type": "int32"
          },
          "host": {
            "type": "string"
          },
          "port": {
            "type": "int32"
          },
          "version": {
            "type": "string"
          },
          "partitions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "partitionId": {
                  "type": "int32"
                },
                "role": {
                  "type": "string"
                },
                "health": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "example": [
        {
          "nodeId": 100,
          "host": "example-value",
          "port": 100,
          "version": "1.0.0",
          "partitions": [
            {
              "partitionId": {},
              "role": {},
              "health": {}
            }
          ]
        }
      ]
    },
    "clusterSize": {
      "type": "int32",
      "example": 100
    },
    "partitionsCount": {
      "type": "int32",
      "example": 100
    },
    "replicationFactor": {
      "type": "int32",
      "example": 100
    },
    "gatewayVersion": {
      "type": "string",
      "example": "1.0.0"
    }
  }
}