Weaviate · JSON Structure

Weaviate Backup Create Request Structure

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

Type: object Properties: 5
Vector DatabaseAIMachine LearningSemantic SearchOpen SourceGraphQLKubernetes

Weaviate Backup Create Request Structure is a JSON Structure definition published by Weaviate, describing 5 properties. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id config include exclude incremental_base_backup_id

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://api-evangelist.github.io/weaviate/json-structure/weaviate-backup-create-request-structure.json",
  "title": "BackupCreateRequest",
  "description": "Request body for creating a backup for a set of collections.",
  "type": "object",
  "properties": {
    "id": {
      "type": "str",
      "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": {
      "type": "#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`."
    },
    "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`."
    },
    "incremental_base_backup_id": {
      "type": "str",
      "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."
    }
  }
}