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

Restore one or every physical tenant from a backup Added in 8.10

POST 
/cluster/v2/restore

Strongly Consistent About endpoint data consistency

Restores physical tenants from backups. The restore is described either by a list of backup IDs or by a time range (from/to) that selects the backups to restore. Restores are only accepted while the targeted physical tenants are in recovery mode; requests are rejected otherwise. The request is validated and acknowledged, but the restore itself is performed asynchronously.

If the physicalTenantId parameter is provided, only that physical tenant is restored and overrides must be omitted.

If it is not provided, every physical tenant of the cluster is restored: those named in overrides with their own backup selection, all others with the selection at the top level of the request body.

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.

Required permissions​

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

Request​

Responses​

The restore request was accepted; returns the planned cluster change covering every requested physical tenant.