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)
      • 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 (shard)

PUT
/collections/:collection_name/shards/:shard_id/snapshots/recover
PUT
/collections/:collection_name/shards/:shard_id/snapshots/recover
$curl -X PUT http://localhost:6333/collections/collection_name/shards/1/snapshots/recover \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "location": "string"
>}'
200Updated
1{
2  "time": 0.002,
3  "status": "ok",
4  "result": true
5}
Recovers the shard of a local collection from a snapshot. This will overwrite any collection data, which is stored in this shard.
Was this page helpful?
Previous

List all snapshots (shard)

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection
shard_idintegerRequired
Id of the shard to recover

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
locationstringRequired
priorityenum or anyOptional
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