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

Retrieve cluster details

GET

/collections/:collection_name/cluster

GET

/collections/:collection_name/cluster

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

200Retrieved

1 {
2   "time": 1.1,
3   "status": "string",
4   "result": {
5     "peer_id": 1,
6     "shard_count": 1,
7     "local_shards": [
8       {
9         "shard_id": 1,
10         "points_count": 1,
11         "state": "Active",
12         "shard_key": "string"
13       }
14     ],
15     "remote_shards": [
16       {
17         "shard_id": 1,
18         "peer_id": 1,
19         "state": "Active",
20         "shard_key": "string"
21       }
22     ],
23     "shard_transfers": [
24       {
25         "shard_id": 1,
26         "from": 1,
27         "to": 1,
28         "sync": true,
29         "method": "stream_records",
30         "comment": "string"
31       }
32     ]
33   }
34 }

Retrieves cluster details for a specified collection.

Was this page helpful?

Update cluster setup

Authentication

api-keystring

API Key authentication via header

Path parameters

collection_namestringRequired

Name of the collection to retrieve the cluster info for

Response

successful operation

timedouble

Time spent to process this request

statusstring

resultobject

Current clustering distribution for the collection