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 Distributed

Check cluster status

GET

/cluster

GET

/cluster

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

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     "status": "disabled"
15   }
16 }

Returns information about the cluster's current state and composition.

Was this page helpful?

Create a shard key

API Reference
- - GETCheck cluster status
  - PUTCreate a shard key
  - POSTDelete a shard key
  - POSTRecover cluster state
  - DELRemove peer from cluster
  - GETRetrieve cluster details
  - POSTUpdate cluster setup

Authentication

api-keystring

API Key authentication via header

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultobject

Information about current cluster status and structure