Sign in

v18

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-0569400504.8 KB
Snapshots

Recover from a snapshot

Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection.

put/collections/{collection_name}/shards/{shard_id}/snapshots/recover

Path parameters

collection_namestring required

Name of the collection

shard_idinteger required

Id of the shard to recover

Query parameters

waitboolean

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

Request body

checksumstring nullable

Optional SHA256 checksum to verify snapshot integrity before recovery.

api_keystring nullable

Optional API key used when fetching the snapshot from a remote URL.

Response

successful operation

timenumber float

Time spent to process this request

statusstring
resultboolean

Example response

{
  "time": 0.002,
  "status": "ok"
}