---
title: "List clusters"
method: GET
path: "/v3/clusters"
tags: ["clusters"]
---

# List clusters

`GET /v3/clusters`

Lists all clusters

## Query parameters

- `name` string
- `binary` string
- `disabled` boolean
- `num_hosts` integer
- `num_down_hosts` integer
- `is_up` boolean
- `limit` integer
- `marker` string
- `sort` string
- `sort_key` string
- `sort_dir` 'asc' | 'desc'

## Response `200`

OK

- Clusters
  - `clusters` ClusterSimple[]
    - `name` string — The cluster name
    - `binary` string — The binary name
    - `state` string — The cluster state
    - `status` string — The cluster status

---

[API](https://skmtc.net/platform9/apis/cluster-blueprint-api.md) · [All operations](https://skmtc.net/platform9/apis/cluster-blueprint-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/platform9/cluster-blueprint-api/revisions/708ad90fe444/schema)