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

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

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?
Previous

Retrieve cluster details

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

peer_idintegerRequired
Id of the peer

Query parameters

timeoutintegerOptional>=1

Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

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