backups

List all created backups

List all created backups IDs, Status

get/backups/{backend}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/backups/{backend}
  • 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 to list backups from (e.g., filesystem, gcs, s3, azure).

Query parameters

order'asc' | 'desc'

Order of returned list of backups based on creation time. (asc or desc)

Response

Successfully retrieved the list of backups in progress.

idstring

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

classesstring[]

The list of collections (classes) for which the backup process was started.

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

Status of backup 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.