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

List all snapshots (storage)

GET
/snapshots
GET
/snapshots
$curl http://localhost:6333/snapshots \
>     -H "api-key: <apiKey>"
200Retrieved
1{
2  "time": 1.1,
3  "status": "string",
4  "result": [
5    {
6      "name": "string",
7      "size": 1,
8      "creation_time": "string",
9      "checksum": "string"
10    }
11  ]
12}
Returns a list of all snapshots for the entire storage.
Was this page helpful?
Previous

Create a snapshot (storage)

Next
Built with

Authentication

api-keystring
API Key authentication via header

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultlist of objects