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

Delete a shard key

POST
/collections/:collection_name/shards/delete
POST
/collections/:collection_name/shards/delete
$curl  -X POST \
>  'http://localhost:6333/collections/collection_name/shards/delete' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "shard_key": "{shard_key}"
>}'
200Successful
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}
Deletes one or more shard keys for a specified collection.
Was this page helpful?
Previous

Collect cluster telemetry data

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to create shards for

Query parameters

timeoutintegerOptional>=1

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

Request

Select shard key to delete
shard_keystring or uint64Required

Response

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