Take a history backupAdded in 8.10

POST 
/backups/history

Strongly Consistent About endpoint data consistency

Triggers a backup of the physical tenant's history, by scheduling a snapshot of every secondary storage index it owns.

Unlike runtime backups, history backups have no generated-id mode: backupId is always required.

Only available on clusters whose secondary storage is Elasticsearch or OpenSearch.

Required permissions

When authorization is enabled, this endpoint requires the following permission. See resources and permissions to learn more.

Resource type	Permission
BACKUP	CREATE

Request

Responses

202

The backup has been successfully scheduled.

400

The provided data is not valid.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

403

The request is forbidden for one of three reasons: the authenticated caller lacks the required BACKUP permission; the cluster's secondary storage is neither Elasticsearch nor OpenSearch and therefore cannot serve history backups; or the physical tenant's snapshot repository is absent from the store — configured under a name the store does not have, or not configured at all. The problem detail says which applies. The latter two are deployment faults the caller cannot correct by changing its request.

409

A backup with the given id already exists, or another backup is already running.

The "already running" check is best-effort and node-local: it only observes backups started by the gateway that serves the request. Two concurrent requests reaching different gateways are narrowed by the duplicate-id check alone.

500

An internal error occurred while processing the request.

503

The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains RESOURCE_EXHAUSTED. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure .