backups

Restore from a backup

Initiates the restoration of collections from a specified backup located on a designated backend.

Requirements:

  • Target cluster must have the same number of nodes as the source cluster where the backup was created.
  • Collections included in the restore must not already exist on the target cluster.
  • Node names must match between the backup and the target cluster.
post/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 to restore from. Must be URL-safe and compatible with filesystem paths (only lowercase, numbers, underscore, minus characters allowed).

Request body

includestring[]

List of collections (classes) to include in the backup restoration process. If not set, all collections in the backup the caller may restore are included. Permits wildcards, e.g. * or prefix*, which match only collections the caller may restore. A list that matches no collection is rejected. Any entry is rejected when the backup contains no collections.

excludestring[]

List of collections (classes) to exclude from the backup restoration process. Any entry is rejected when the backup contains no collections.

node_mappingobject

Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment.

overwriteAliasboolean

Allows ovewriting the collection alias if there is a conflict

Response

Backup restoration process initiated successfully. Check the status endpoint for 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 restoration process was started.

backendstring

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

pathstring

Destination path of backup files valid for the selected backend.

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.