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)
      • GETDownload shard snapshot
      • 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 (collection)

GET
/collections/:collection_name/snapshots
GET
/collections/:collection_name/snapshots
$curl  -X GET \
>  'http://localhost:6333/collections/collection_name/snapshots' \
>  --header 'api-key: <api-key-value>'
200Retrieved
1{
2  "usage": {
3    "hardware": {
4      "cpu": 1,
5      "payload_io_read": 1,
6      "payload_io_write": 1,
7      "payload_index_io_read": 1,
8      "payload_index_io_write": 1,
9      "vector_io_read": 1,
10      "vector_io_write": 1
11    },
12    "inference": {
13      "models": {}
14    }
15  },
16  "time": 0.002,
17  "status": "ok",
18  "result": [
19    {
20      "name": "string",
21      "size": 1,
22      "creation_time": "string",
23      "checksum": "string"
24    }
25  ]
26}
Retrieves a list of all snapshots for a specified collection.
Was this page helpful?
Previous

Create a snapshot (collection)

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection

Response

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