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

Update cluster setup

POST
/collections/:collection_name/cluster
POST
/collections/:collection_name/cluster
$curl -X POST http://localhost:6333/collections/collection_name/cluster \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "abort_resharding": {}
>}'
200Successful
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}
Updates the cluster configuration for a specified collection.
Was this page helpful?
Previous

Collect telemetry data

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection on which to to apply the cluster update operation

Query parameters

timeoutintegerOptional

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

Request

Collection cluster update operations
MoveShardOperationobjectRequired
OR
ReplicateShardOperationobjectRequired
OR
AbortTransferOperationobjectRequired
OR
DropReplicaOperationobjectRequired
OR
CreateShardingKeyOperationobjectRequired
OR
DropShardingKeyOperationobjectRequired
OR
RestartTransferOperationobjectRequired
OR
StartReshardingOperationobjectRequired
OR
AbortReshardingOperationobjectRequired

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultboolean