backups

Get backup restoration status

Checks the status of a specific backup restoration process identified by the backup ID on the specified backend.

Client libraries often provide a 'wait for completion' feature that polls this endpoint automatically. Use this endpoint for manual status checks or if 'wait for completion' is disabled.

get/backups/{backend}/{id}/restore

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/backups/{backend}/{id}/restore
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

backendstring required

Specifies the backend storage system where the backup resides (e.g., filesystem, gcs, s3, azure).

idstring required

The unique identifier of the backup being restored. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed).

Query parameters

bucketstring

Optional: Specifies the bucket, container, or volume name if required by the backend.

pathstring

Optional: Specifies the path within the bucket.

Response

Successfully retrieved the status of the backup restoration process.

idstring

The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.

backendstring

Backup backend name e.g. filesystem, gcs, s3.

pathstring

Destination path of backup files valid for the selected backup backend, contains bucket and path.

errorstring

Error message if backup restoration failed.

status'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'FINALIZING' | 'SUCCESS' | 'FAILED' | 'CANCELLING' | 'CANCELED'

Phase of backup restoration process.

Changes

No recorded changes to this operation across all 1 revision of this API.