Restore from a backupAdded in 8.10

POST 
/restore

Strongly Consistent About endpoint data consistency

Restores the cluster from a backup. The restore is described either by a single backup ID or by a time range (from/to) that selects the backups to restore. This endpoint is only accessible while the cluster is in recovery mode; requests are rejected otherwise. The request is validated and acknowledged, but the restore itself is performed asynchronously.

Required permissions

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

Resource type	Permission
BACKUP	RESTORE

Request

Responses

202

The restore request was accepted; returns the planned cluster changes.

400

The provided data is not valid.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

403

Forbidden. The request is not allowed.

409

The cluster is not in recovery mode, so the restore cannot be accepted.

500

An internal error occurred while processing the request.