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.

API Reference

API Reference Distributed

Collect cluster telemetry data

GET

/cluster/telemetry

GET

/cluster/telemetry

$ curl http://localhost:6333/cluster/telemetry \
>      -H "api-key: <apiKey>"

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     "collections": {},
20     "cluster": {
21       "enabled": true,
22       "number_of_peers": 1,
23       "peers": {}
24     }
25   }
26 }

Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status

Was this page helpful?

Recover cluster state

Authentication

api-keystring

API Key authentication via header

Query parameters

details_levelintegerOptional

The level of detail to include in the response

timeoutintegerOptional>=1Defaults to 60

Timeout for this request

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultobject