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.

collection_namestringRequired

Name of the collection

shard_idintegerRequired

Id of the shard to recover

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.

This endpoint expects a multipart form containing an optional file.

snapshotfileOptional

This endpoint returns an object.

timedoubleOptional

Time spent to process this request

statusstringOptional

resultbooleanOptional

1	curl -X POST http://localhost:6333/collections/collection_name/shards/1/snapshots/upload \
2	-H "api-key: <apiKey>" \
3	-H "Content-Type: multipart/form-data" \
4	-F snapshot=@<file1>