Snapshots

Recover shard from an uploaded snapshot

Changed on

Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard.

post/collections/{collection_name}/shards/{shard_id}/snapshots/upload

Request

Path parameters

collection_namestring required

Name of the collection

shard_idinteger required

Id of the shard to recover

Query parameters

waitboolean

If true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

priority'no_sync' | 'snapshot' | 'replica'

Defines source of truth for snapshot recovery:

NoSync means - restore snapshot without any additional synchronization. Snapshot means - prefer snapshot data over the current state. Replica means - prefer existing data over the snapshot.

Defines source of truth for snapshot recovery

checksumstring

Optional SHA256 checksum to verify snapshot integrity before recovery.

Request body multipart/form-data

snapshotstring binary

Response

successful operation

timenumber float

Time spent to process this request

statusstring
resultboolean

Example response

{
  "time": 0.002,
  "status": "ok"
}

Changes