API ReferenceSnapshots

Recover from an uploaded snapshot (shard)

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

Headers

api-keystringRequired

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:
checksumstringOptional

Optional SHA256 checksum to verify snapshot integrity before recovery.

Request

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

Response

This endpoint returns an object.
timedoubleOptional

Time spent to process this request

statusstringOptional
resultbooleanOptional