> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.qdrant.tech/v-1-17-x/api-reference/distributed/cluster-status/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.qdrant.tech/_mcp/server.

# Check cluster status

GET http://localhost:6333/cluster

Returns information about the cluster's current state and composition.

Reference: https://api.qdrant.tech/api-reference/distributed/cluster-status

## Authentication

- `api-key` header (required) — API Key authentication via header

## Servers

- `http://localhost:6333` (http, default)
- `https://localhost:6333` (https)

## Response

### 200

successful operation

- `usage` (ClusterGetResponsesContentApplicationJsonSchemaUsage, optional)
- `time` (double, optional) — Time spent to process this request
- `status` (string, optional)
- `result` (ClusterStatus, optional) — Information about current cluster status and structure

## Types

### ClusterGetResponsesContentApplicationJsonSchemaUsage

### ClusterStatus

Information about current cluster status and structure

### Usage

Usage of the hardware resources, spent to process the request

- `hardware` (UsageHardware, optional)
- `inference` (UsageInference, optional)

### ClusterStatus0

- `status` (enum, required)
  - Allowed values: `disabled`

### ClusterStatus1

Description of enabled cluster

- `status` (enum, required)
  - Allowed values: `enabled`
- `peer_id` (uint64, required) — ID of this peer
- `peers` (map from string to PeerInfo, required) — Peers composition of the cluster with main information
- `raft_info` (RaftInfo, required) — Summary information about the current raft state
- `consensus_thread_status` (ConsensusThreadStatus, required) — Information about current consensus thread status
- `message_send_failures` (map from string to MessageSendErrors, required) — Consequent failures of message send operations in consensus by peer address. On the first success to send to that peer - entry is removed from this hashmap.

### UsageHardware

### UsageInference

### PeerInfo

Information of a peer in the cluster

- `uri` (string, required)

### RaftInfo

Summary information about the current raft state

- `term` (uint64, required) — Raft divides time into terms of arbitrary length, each beginning with an election. If a candidate wins the election, it remains the leader for the rest of the term. The term number increases monotonically. Each server stores the current term number which is also exchanged in every communication.
- `commit` (uint64, required) — The index of the latest committed (finalized) operation that this peer is aware of.
- `pending_operations` (integer, required) — Number of consensus operations pending to be applied on this peer
- `is_voter` (boolean, required) — Is this peer a voter or a learner
- `leader` (uint64, optional, nullable) — Leader of the current term
- `role` (RaftInfoRole, optional) — Role of this peer in the current term

### ConsensusThreadStatus

Information about current consensus thread status

### MessageSendErrors

Message send failures for a particular peer

- `count` (integer, required)
- `latest_error` (string, optional, nullable)
- `latest_error_timestamp` (string, optional, nullable) — Timestamp of the latest error

### HardwareUsage

Usage of the hardware resources, spent to process the request

- `cpu` (integer, required)
- `payload_io_read` (integer, required)
- `payload_io_write` (integer, required)
- `payload_index_io_read` (integer, required)
- `payload_index_io_write` (integer, required)
- `vector_io_read` (integer, required)
- `vector_io_write` (integer, required)

### InferenceUsage

- `models` (map from string to ModelUsage, required)

### RaftInfoRole

Role of this peer in the current term

### ConsensusThreadStatus0

- `consensus_thread_status` (enum, required)
  - Allowed values: `working`
- `last_update` (string, required)

### ConsensusThreadStatus1

- `consensus_thread_status` (enum, required)
  - Allowed values: `stopped`

### ConsensusThreadStatus2

- `consensus_thread_status` (enum, required)
  - Allowed values: `stopped_with_err`
- `err` (string, required)

### ModelUsage

- `tokens` (uint64, required)

## Examples

**Response**

```json
{
  "usage": {
    "hardware": {
      "cpu": 1,
      "payload_io_read": 1,
      "payload_io_write": 1,
      "payload_index_io_read": 1,
      "payload_index_io_write": 1,
      "vector_io_read": 1,
      "vector_io_write": 1
    },
    "inference": {
      "models": {}
    }
  },
  "time": 0.002,
  "status": "ok",
  "result": {
    "status": "disabled"
  }
}
```

**SDK Code**

```python
import requests

url = "http://localhost:6333/cluster"

headers = {"api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:6333/cluster';
const options = {method: 'GET', headers: {'api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:6333/cluster"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:6333/cluster")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:6333/cluster")
  .header("api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:6333/cluster', [
  'headers' => [
    'api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:6333/cluster");
var request = new RestRequest(Method.GET);
request.AddHeader("api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:6333/cluster")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```