For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETList all snapshots (collection)
      • POSTCreate a snapshot (collection)
      • POSTRecover from an uploaded snapshot (collection)
      • PUTRecover from a snapshot (collection)
      • GETDownload a snapshot (collection)
      • DELDelete a snapshot (collection)
      • GETList all snapshots (storage)
      • POSTCreate a snapshot (storage)
      • GETDownload a snapshot (storage)
      • DELDelete a snapshot (storage)
      • GETDownload shard snapshot
      • POSTRecover from an uploaded snapshot (shard)
      • PUTRecover from a snapshot (shard)
      • GETList all snapshots (shard)
      • POSTCreate a snapshot (shard)
      • GETDownload a snapshot (shard)
      • DELDelete a snapshot (shard)
LogoLogo
CloudGitHub
API ReferenceSnapshots

Recover from a snapshot (collection)

PUT
/collections/:collection_name/snapshots/recover
PUT
/collections/:collection_name/snapshots/recover
$curl  -X PUT \
>  'http://localhost:6333/collections/collection_name/snapshots/recover' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "location": "http://example.com/path/to/snapshot.shapshot"
>}'
200Updated
1{
2  "time": 0.002,
3  "status": "ok",
4  "result": true
5}
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.
Was this page helpful?
Previous

Download a snapshot (collection)

Next
Built with

Authentication

api-keystring
API Key authentication via header

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 if will be synchronized with the snapshot.

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
timedouble
Time spent to process this request
statusstring
resultboolean