For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETList all snapshots (collection)
      • POSTCreate a snapshot (collection)
      • POSTRecover from an uploaded snapshot (collection)
      • PUTRecover from a snapshot (collection)
      • GETDownload a snapshot (collection)
      • DELDelete a snapshot (collection)
      • GETList all snapshots (storage)
      • POSTCreate a snapshot (storage)
      • GETDownload a snapshot (storage)
      • DELDelete a snapshot (storage)
      • POSTRecover from an uploaded snapshot (shard)
      • PUTRecover from a snapshot (shard)
      • GETList all snapshots (shard)
      • POSTCreate a snapshot (shard)
      • GETDownload a snapshot (shard)
      • DELDelete a snapshot (shard)
LogoLogo
CloudGitHub
API ReferenceSnapshots

Recover from an uploaded snapshot (collection)

POST
/collections/:collection_name/snapshots/upload
POST
/collections/:collection_name/snapshots/upload
$curl -X POST http://localhost:6333/collections/collection_name/snapshots/upload \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: multipart/form-data" \
>     -F snapshot=@<file1>
200Successful
1{
2  "time": 1.1,
3  "status": "string",
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.
Was this page helpful?
Previous

Recover from a snapshot (collection)

Next
Built with

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
timedouble
Time spent to process this request
statusstring
resultboolean