backups

Get backup creation status

Checks the status of a specific backup creation process identified by its 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}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/backups/{backend}/{id}
  • 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. 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/container/volume if the backup is not at the root.

Response

Successfully retrieved the status of the backup creation 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 backend.

errorstring

error message if creation failed

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

phase of backup creation process

startedAtstring date-time

Timestamp when the backup process started

completedAtstring date-time

Timestamp when the backup process completed (successfully or with failure)

sizenumber

Size of the backup in Gibs

incremental_base_backup_idstring

The ID of the base backup this incremental backup was built on; empty if the backup is not incremental.

Changes

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