LogoLogo
CloudGitHub
  • API Reference
CloudGitHub
API ReferenceSnapshots

Recover from an uploaded snapshot (collection)

POST
/collections/:collection_name/snapshots/upload
POST
/collections/:collection_name/snapshots/upload
1curl  -X POST \
2  'http://localhost:6333/collections/collection_name/snapshots/upload' \
3  --header 'api-key: <api-key-value>' \
4  --form 'snapshot=@/path/to/snapshot.shapshot'
Try it
200Successful
1{
2  "time": 0.002,
3  "status": "ok",
4  "result": true
5}
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.

Path parameters

collection_namestringRequired
Name of the collection

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

Snapshot to recover from
snapshotfileOptional

Response

successful operation
timedouble or null
Time spent to process this request
statusstring or null
resultboolean or null
Was this page helpful?
Previous

Recover from a snapshot (collection)

Next
Built with
Name of the collection
Defines source of truth for snapshot recovery
Optional SHA256 checksum to verify snapshot integrity before recovery.
Snapshot to recover from
successful operation

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