Skip to navigation
API ReferenceSnapshots

Recover from a snapshot (collection)

Recovers local collection data from a snapshot. This will overwrite any collection data stored on the node. If the collection does not exist, it will be created.

Authentication

api-keystring

Authorization key, either read-write or read-only

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_namestringRequired
Name of the collection

Query parameters

waitbooleanOptional

If true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Request

Snapshot to recover from
locationstringRequiredformat: "uri"

Examples: - URL http://localhost:8080/collections/my_collection/snapshots/my_snapshot - Local path file:///qdrant/snapshots/test_collection-2022-08-04-10-49-10.snapshot

priorityenum or anyOptional

Defines which data should be used as a source of truth if there are other replicas in the cluster. If set to Snapshot, the snapshot will be used as a source of truth, and the current state will be overwritten. If set to Replica, the current state will be used as a source of truth, and after recovery it will be synchronized from other replicas.

checksumstring or nullOptional
Optional SHA256 checksum to verify snapshot integrity before recovery.
api_keystring or nullOptional
Optional API key used when fetching the snapshot from a remote URL.

Response

successful operation
timefloatOptional
Time spent to process this request
statusstringOptional
resultbooleanOptional

Errors

4XX
Client Request Error