backups

Create a backup

Initiates the creation of a backup for specified collections on a designated backend storage.

Notes:

  • Backups are compressed using gzip by default.
  • Weaviate remains operational during the backup process.
post/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 where the backup will be stored (e.g., filesystem, gcs, s3, azure).

Request body

idstring

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

includestring[]

List of collections to include in the backup creation process. If not set, all collections the caller may back up are included. Cannot be used together with exclude. Permits wildcards, e.g. * or prefix*, which match only collections the caller may back up. A list that matches no collection is allowed when users or roles are selected, including through omitted identity selectors.

excludestring[]

List of collections to exclude from the backup creation process. If not set, all collections the caller may back up are included. Cannot be used together with include. Permits wildcards, e.g. * or prefix*. Excluding every collection is allowed when users or roles are selected, including through omitted identity selectors.

includeUsersstring[]

List of dynamic DB users to include in the backup. Permits * and ? wildcards, e.g. * or prefix*. When omitted or null, the whole dynamic-user store is captured. An empty list or wildcards matching nothing omit the user snapshot; restoring it leaves existing users untouched. Otherwise, only matching users are captured. An exact user name that does not exist is rejected. Selected users, including those selected by omission, permit a backup with zero collections. No per-user permission check is applied.

includeRolesstring[]

List of RBAC roles to include in the backup. Permits * and ? wildcards, e.g. * or prefix*. When omitted or null, the whole RBAC state is captured, including built-in roles and assignments. An empty list or wildcards matching nothing omit the RBAC snapshot; restoring it leaves existing roles untouched. Otherwise, only matching roles are captured. An exact role name that does not exist is rejected. Explicit selectors cannot select built-in roles: exact names are rejected and wildcards exclude them. Selected roles, including built-in roles selected by omission, permit a backup with zero collections. No per-role permission check is applied.

incremental_base_backup_idstring nullable

The ID of an existing backup to use as the base for a file-based incremental backup. If set, only files that have changed since the base backup will be included in the new backup.

Response

Backup creation 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 creation process was started.

backendstring

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

bucketstring

Name of the bucket, container, volume, etc

pathstring

Path within bucket of backup

errorstring

error message if creation failed

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

phase of backup creation process

Changes

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