Weaviate · Schema

BackupCreateRequest

Request body for creating a backup for a set of collections.

Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Properties

Name Type Description
id string The ID of the backup (required). Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.
config object
include array List of collections to include in the backup creation process. If not set, all collections are included. Cannot be used together with `exclude`.
exclude array List of collections to exclude from the backup creation process. If not set, all collections are included. Cannot be used together with `include`.
incremental_base_backup_id string 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.
View JSON Schema on GitHub

JSON Schema

weaviate-backup-create-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-backup-create-request-schema.json",
  "title": "BackupCreateRequest",
  "description": "Request body for creating a backup for a set of collections.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the backup (required). Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed."
    },
    "config": {
      "$ref": "#/components/schemas/BackupConfig"
    },
    "include": {
      "type": "array",
      "description": "List of collections to include in the backup creation process. If not set, all collections are included. Cannot be used together with `exclude`.",
      "items": {
        "type": "string"
      }
    },
    "exclude": {
      "type": "array",
      "description": "List of collections to exclude from the backup creation process. If not set, all collections are included. Cannot be used together with `include`.",
      "items": {
        "type": "string"
      }
    },
    "incremental_base_backup_id": {
      "type": "string",
      "description": "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.",
      "default": null
    }
  }
}