---
title: "Backup lists"
method: PUT
path: "/xlist/backup"
tags: ["multilist"]
---

# Backup lists

`PUT /xlist/backup`

Backup lists.
If no lists, nor any search is specified all lists are backed up.A callback is provided to check progress.

Required security scopes:
  * `api:manage`

## Request body

- MultiListBackup
  - `destination` BackupDestination, required
    - `path` string — Specifies the destination path. If type is server, this should be ip+port of the other server, eg. 10.0.0.1:8080. If the type is s3, the source should be specified as s3://bucket/path/file.bin. Replace bucket and path+file
    - `server_list_id_prefix` string — Optional alternative list id prefix for server-to-server transfers. If not provided the original list id/segment ids will be used and any existing list will be overwritten.
    - `server_list_id_suffix` string — Optional alternative list id suffix for server-to-server transfers. If not provided the original list id/segment ids will be used and any existing list will be overwritten.
    - `type` string, required — Specifies the destination type of the backup. Can be 'file' 'download', 's3' or 'server'
  - `lists` ListQL, required
    - `all_in_sets` string[] — Include all lists in these sets
    - `lists` string[] — Include lists that match exact list names
    - `match_metadata` object — Include lists that match all values in metadata

## Response `200`

Returned when backup type is "download". The raw backup content is returned

## Other responses

- `201` — Returned when the operation is started in the background
- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivino/apis/the-rankdb-api.md) · [All operations](https://skmtc.net/vivino/apis/the-rankdb-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivino/the-rankdb-api/revisions/7a45b5309a11/schema)