Skip to navigation
API ReferenceSnapshots

Recover from an uploaded snapshot (collection)

Recovers local collection data from an uploaded snapshot. This will overwrite any collection data stored on the node. If the collection does not exist, it will be created.

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection

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

Snapshot to recover from
snapshotfileOptional

Response

successful operation
timedoubleOptional
Time spent to process this request
statusstringOptional
resultbooleanOptional