Skip to main content

backup

Manage Saleor Cloud backups​

backup​

$ saleor backup --help

Help output:

saleor backup [command]

Manage Saleor Cloud backups

Commands:
  saleor backup list                      List backups of the organization
  saleor backup create [name]             Create a new backup
  saleor backup show [backup|backup-key]  Show a specific backup
  saleor backup remove <key|backup>       Remove the backup
  saleor backup restore [from]            Restore a specific backup

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

backup list​

$ saleor backup list --help

Help output:

saleor backup list

List backups of the organization

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
      --name             filter the output for name for backup  [string]
      --latest           show only the latest backup  [boolean] [default: false]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

Examples:
  saleor backup list
  saleor backup list --organization="organization-slug"

backup create​

$ saleor backup create --help

Help output:

saleor backup create [name]

Create a new backup

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
      --name             name for the new backup  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

Examples:
  saleor backup create
  saleor backup create my-backup --organization="organization-slug"

backup show​

$ saleor backup show --help

Help output:

saleor backup show [backup|backup-key]

Show a specific backup

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

Examples:
  saleor backup show
  saleor backup show
  saleor backup show backup-key
  saleor backup show backup-key --organization="organization-slug"

backup remove​

$ saleor backup remove --help

Help output:

saleor backup remove <key|backup>

Remove the backup

Positionals:
  key, backup  key of the backup  [string] [required]

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
      --force            skip confirmation prompt  [boolean]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

Examples:
  saleor backup remove
  saleor backup remove backup-key --force
  saleor backup remove backup-key --force --organization="organization-slug"
Expand ▼

backup restore​

$ saleor backup restore --help

Help output:

saleor backup restore [from]

Restore a specific backup

Options:
      --json                  Output the data as JSON  [boolean] [default: false]
      --short                 Output data as text  [boolean] [default: false]
  -u, --instance, --url       Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
      --from                  the key of the snapshot  [string]
      --skip-webhooks-update  skip webhooks update prompt  [boolean]
  -V, --version               Show version number  [boolean]
  -h, --help                  Show help  [boolean]

Examples:
  saleor backup restore
  saleor backup restore --from="backup-key" --skip-webhooks-update
  saleor backup restore --from="backup-key" --skip-webhooks-update --organization="organization-slug" --environment="env-id-or-name"