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

Force-write runtime backup state across physical tenants Added in 8.10

POST 
/cluster/v2/backups/runtime/state/sync

Strongly Consistent About endpoint data consistency

Force-writes the checkpoint and backup metadata of every partition of every physical tenant of the cluster, or of the one named by physicalTenantId, to that tenant's backup store, independent of any backup being taken or confirmed, and returns the updated state per physical tenant.

The request is all-or-nothing: a physical tenant whose metadata cannot be written fails the whole request, and the writes that already succeeded on other tenants are not undone. The operation is idempotent, so retrying the same call is the correct remedy. Narrow the request with physicalTenantId to write the tenants that can still be reached.

Requires the cluster-admin security chain. Although this operation lists bearerAuth / basicAuth like the rest of the Orchestration Cluster API, it does not accept an Orchestration Cluster user's credentials — only the separate cluster-admin credentials are valid here. Use POST /v2/backups/runtime/state/sync to act as a single physical tenant.

Required permissions​

Even when authorization is enabled, this endpoint requires no specific permission. See resources and permissions to learn more.

Request​

Responses​

The updated runtime backup state of every targeted physical tenant, ordered by physical tenant id.