Snapshots

Recover from a snapshot (shard)

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

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

This endpoint expects an object.
location
stringRequired
priority
unionOptional
checksum
stringOptional
Optional SHA256 checksum to verify snapshot integrity before recovery.
api_key
stringOptional
Optional API key used when fetching the snapshot from a remote URL.

Response

This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
booleanOptional