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  -X GET \
>  'http://localhost:6333/snapshots' \
>  --header 'api-key: <api-key-value>'
200Retrieved
1{
2  "usage": {
3    "cpu": 1,
4    "payload_io_read": 1,
5    "payload_io_write": 1,
6    "payload_index_io_read": 1,
7    "payload_index_io_write": 1,
8    "vector_io_read": 1,
9    "vector_io_write": 1
10  },
11  "time": 0.002,
12  "status": "ok",
13  "result": [
14    {
15      "name": "string",
16      "size": 1,
17      "creation_time": "string",
18      "checksum": "string"
19    }
20  ]
21}
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
usageobject or any
timedouble
Time spent to process this request
statusstring
resultlist of objects