API ReferenceSnapshots

Recover from a snapshot (shard)

Recovers the shard of a local collection from a snapshot. This will overwrite any collection data, which is stored in this shard.

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.

Response

successful operation
timedouble or null
Time spent to process this request
statusstring or null
resultboolean or null