Snapshots API

REST API endpoints for creating, managing, and restoring snapshots in Qdrant

Snapshots provide a way to create backups of collections and the entire Qdrant storage. Use these endpoints to create snapshots, download them, and restore from backups.

Create Collection Snapshot

Create a new snapshot for a specific collection.

curl -X POST 'http://localhost:6333/collections/{collection_name}/snapshots'

Path Parameters

collection_name · string · required

Name of the collection to snapshot

Query Parameters

wait · boolean

If true, wait for the snapshot to complete. If false, let it happen in background. Default is true.

Response

result · object

name · string

Snapshot filename

creation_time · string

ISO 8601 timestamp of creation

size · integer

Snapshot size in bytes

checksum · string

SHA256 checksum of the snapshot file

List Collection Snapshots

Get a list of all snapshots for a specific collection.

curl -X GET 'http://localhost:6333/collections/{collection_name}/snapshots'

Path Parameters

collection_name · string · required

Name of the collection

Response

result · array

Array of snapshot descriptions

name · string

Snapshot filename

creation_time · string

ISO 8601 timestamp

size · integer

Size in bytes

checksum · string

SHA256 checksum

Download Collection Snapshot

Download a specific collection snapshot as a file.

curl -X GET 'http://localhost:6333/collections/{collection_name}/snapshots/{snapshot_name}' \
  -o snapshot.tar

Path Parameters

collection_name · string · required

Name of the collection

snapshot_name · string · required

Name of the snapshot to download

Response

Binary snapshot file (application/octet-stream)

Delete Collection Snapshot

Delete a specific collection snapshot.

curl -X DELETE 'http://localhost:6333/collections/{collection_name}/snapshots/{snapshot_name}'

Path Parameters

collection_name · string · required

Name of the collection

snapshot_name · string · required

Name of the snapshot to delete

Query Parameters

wait · boolean

If true, wait for deletion to complete. Default is true.

Response

result · boolean

Returns true if snapshot was deleted successfully

Recover from Snapshot

Recover local collection data from an existing snapshot. This will overwrite any data stored on this node for the collection.

curl -X PUT 'http://localhost:6333/collections/{collection_name}/snapshots/recover' \
  -H 'Content-Type: application/json' \
  -d '{
    "location": "http://example.com/snapshots/my-snapshot.tar"
  }'

Path Parameters

collection_name · string · required

Name of the collection to recover. If collection does not exist, it will be created.

Query Parameters

wait · boolean

If true, wait for recovery to complete. If false, let it happen in background. Default is true.

Request Body

location · string · required

URL or file path of the snapshot to recover from

priority · string

Defines source of truth for recovery: snapshot or replica. Default is replica.

checksum · string

Optional SHA256 checksum to verify snapshot integrity

Response

result · boolean

Returns true if recovery started/completed successfully

Upload and Recover from Snapshot

Upload a snapshot file and recover collection data from it.

curl -X POST 'http://localhost:6333/collections/{collection_name}/snapshots/upload' \
  -F 'snapshot=@/path/to/snapshot.tar'

Path Parameters

collection_name · string · required

Name of the collection to recover. If collection does not exist, it will be created.

Query Parameters

wait · boolean

If true, wait for recovery to complete. Default is true.

priority · string

Defines source of truth: snapshot or replica

checksum · string

Optional SHA256 checksum to verify snapshot integrity before recovery

Request Body

Multipart form data with snapshot file

Response

result · boolean

Returns true if recovery started/completed successfully

Create Full Storage Snapshot

Create a snapshot of the entire Qdrant storage, including all collections.

curl -X POST 'http://localhost:6333/snapshots'

Query Parameters

wait · boolean

If true, wait for the snapshot to complete. If false, let it happen in background. Default is true.

Response

result · object

name · string

Snapshot filename

creation_time · string

ISO 8601 timestamp of creation

size · integer

Snapshot size in bytes

checksum · string

SHA256 checksum

List Full Storage Snapshots

Get a list of all full storage snapshots.

curl -X GET 'http://localhost:6333/snapshots'

Response

result · array

Array of snapshot descriptions for all storage snapshots

Download Full Storage Snapshot

Download a full storage snapshot as a file.

curl -X GET 'http://localhost:6333/snapshots/{snapshot_name}' \
  -o full-snapshot.tar

Path Parameters

snapshot_name · string · required

Name of the snapshot to download

Response

Binary snapshot file (application/octet-stream)

Delete Full Storage Snapshot

Delete a full storage snapshot.

curl -X DELETE 'http://localhost:6333/snapshots/{snapshot_name}'

Path Parameters

snapshot_name · string · required

Name of the snapshot to delete

Query Parameters

wait · boolean

If true, wait for deletion to complete. Default is true.

Response

result · boolean

Returns true if snapshot was deleted successfully

Download Shard Snapshot

Stream the current state of a shard as a snapshot file. This is useful for shard-level backup and replication.

curl -X GET 'http://localhost:6333/collections/{collection_name}/shards/{shard_id}/snapshot' \
  -o shard-snapshot.tar

Path Parameters

collection_name · string · required

Name of the collection

shard_id · integer · required

ID of the shard to snapshot

Response

Binary shard snapshot file (application/octet-stream)