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
      • GETCheck cluster status
      • PUTCreate a shard key
      • POSTDelete a shard key
      • POSTRecover cluster state
      • DELRemove peer from cluster
      • GETRetrieve cluster details
      • POSTUpdate cluster setup
LogoLogo
CloudGitHub
API ReferenceDistributed

Check cluster status

GET
/cluster
GET
/cluster
$curl http://localhost:6333/cluster \
>     -H "api-key: <apiKey>"
200Retrieved
1{
2  "usage": {
3    "cpu": 1,
4    "io_read": 1,
5    "io_write": 1
6  },
7  "time": 0.002,
8  "status": "ok",
9  "result": {
10    "status": "disabled"
11  }
12}
Returns information about the cluster's current state and composition.
Was this page helpful?
Previous

Create a shard key

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
resultobject
Information about current cluster status and structure