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

Remove peer from cluster

DELETE

/cluster/peer/:peer_id

DELETE

/cluster/peer/:peer_id

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

200Deleted

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": true
14 }

Attempts to remove the node from the cluster. This endpoint returns an error if the node (peer) has shards on it.

Was this page helpful?

Retrieve cluster details

Authentication

api-keystring

API Key authentication via header

Path parameters

peer_idintegerRequired

Id of the peer

Query parameters

forcebooleanOptionalDefaults to false

If true - removes peer even if it has shards/replicas on it.

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultboolean