For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.11 (unreleased)

Cluster management API

The cluster management API lets you manage a Self-Managed Orchestration Cluster at runtime, including its topology, exporters, backups, and upgrade readiness.

About this API​

The API is a set of custom endpoints available through Spring Boot Actuator on the management port (default 9600). It's separate from the Orchestration Cluster API.

note

The management port is typically not publicly exposed. If the machine where you run requests can't reach the gateway, create a private connection such as kubectl port-forward svc/camunda-zeebe-gateway 9600:9600, then use localhost as the gateway host.

Reference​

APIBase path
Cluster topology management/actuator/cluster
Exporters/actuator/exporters
Backups/actuator/backupRuntime, /actuator/backupHistory
Upgrade readiness/actuator/upgradeReadiness

For usage guidance and examples, see management API operations.