Snapshots

Recover from an uploaded snapshot (shard)

POST
Recovers the shard of a local collection from an uploaded 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.
priorityenumOptional
Defines source of truth for snapshot recovery
Allowed values: no_syncsnapshotreplica
checksumstringOptional
Optional SHA256 checksum to verify snapshot integrity before recovery.

Request

This endpoint expects a multipart form containing an optional file.
snapshotoptional file

Response

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