v1.10.x
Search...
/
Cloud
GitHub
API Reference
Collections
Points
Search
Indexes
Snapshots
GET
List all snapshots (collection)
POST
Create a snapshot (collection)
POST
Recover from an uploaded snapshot (collection)
PUT
Recover from a snapshot (collection)
GET
Download a snapshot (collection)
DEL
Delete a snapshot (collection)
GET
List all snapshots (storage)
POST
Create a snapshot (storage)
GET
Download a snapshot (storage)
DEL
Delete a snapshot (storage)
POST
Recover from an uploaded snapshot (shard)
PUT
Recover from a snapshot (shard)
GET
List all snapshots (shard)
POST
Create a snapshot (shard)
GET
Download a snapshot (shard)
DEL
Delete a snapshot (shard)
Aliases
Distributed
Service
Beta
Cloud
GitHub
API Reference
Snapshots
Recover from an uploaded snapshot (shard)
POST
http://localhost:6333
/
collections
/
:collection_name
/
shards
/
:shard_id
/
snapshots
/
upload
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_name
string
Required
Name of the collection
shard_id
integer
Required
Id of the shard to recover
Query parameters
wait
boolean
Optional
If true, wait for changes to actually happen. If false - let changes happen in background. Default is true.
priority
enum
Optional
Defines source of truth for snapshot recovery
Allowed values:
no_sync
snapshot
replica
checksum
string
Optional
Optional SHA256 checksum to verify snapshot integrity before recovery.
Request
This endpoint expects a multipart form containing an optional file.
snapshot
file
Optional
Response
This endpoint returns an object.
time
double
Optional
Time spent to process this request
status
string
Optional
result
boolean
Optional
Built with