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

# List test clusters.

`GET /clusters`

Required RBAC Policy: kots/cluster/list

## Query parameters

- `pageSize` integer
- `currentPage` integer
- `sortColumn` string
- `sortDesc` boolean
- `show-terminated` boolean
- `start-time` string
- `end-time` string
- `actor-filter` string
- `tag-filter` string
- `tag-sort-key` string

## Response `200`

ListClustersResponse contains the response to list clusters

- object
  - `clusters` Cluster[]
    - `actor` Actor
      - `description` string
      - `id` string
      - `link` string
      - `timestamp` string, date-time
      - `type` string
    - `addons` ClusterAddon[]
      - `cluster_guid` string
      - `cluster_id` string
      - `created_at` string, date-time
      - `guid` string
      - `id` string
      - `object_store` ClusterAddonObjectStore
        - `bucket_name` string
        - `bucket_prefix` string
        - `service_account_name` string
        - `service_account_name_read_only` string
        - `service_account_namespace` string
      - `port` ClusterAddonPort
        - `is_wildcard` boolean
        - `name` string
        - `protocol_http` boolean
        - `protocol_https` boolean
        - `protocol_ws` boolean
        - `protocol_wss` boolean
        - `upstream_port` integer
      - `ready_at` string, date-time
      - `status` string
      - `terminated_at` string, date-time
      - `total_credits` integer
    - `assigned_at` string, date-time
    - `cluster_node` ClusterNode
      - `join_command` string
      - `network_id` string — Used by vxlan nodes
      - `network_public_ips` string[]
      - `node_group_id` string
      - `node_index` integer
      - `node_type` string
      - `ssh_endpoint` string
      - `ssh_key` string
      - `ssh_port` integer
    - `created_at` string, date-time
    - `credits_per_hour_per_cluster` integer
    - `distribution` string
    - `expires_at` string, date-time
    - `flat_fee` integer
    - `guid` string
    - `id` string
    - `installer_url` string
    - `ip_family` string
    - `kubernetes_distribution` string
    - `kubernetes_version` string
    - `last_scheduling_status` string
    - `license_id` string
    - `name` string
    - `network_id` string
    - `node_groups` NodeGroup[]
      - `cluster_guid` string
      - `created_at` string, date-time
      - `credits_per_hour` integer
      - `disk_gib` integer
      - `id` string
      - `instance_type` string
      - `is_default` boolean
      - `max_node_count` integer
      - `min_node_count` integer
      - `minutes_billed` integer
      - `name` string
      - `node_count` integer
      - `nodes` ClusterNode[]
        - `join_command` string
        - `network_id` string — Used by vxlan nodes
        - `network_public_ips` string[]
        - `node_group_id` string
        - `node_index` integer
        - `node_type` string
        - `ssh_endpoint` string
        - `ssh_key` string
        - `ssh_port` integer
      - `running_at` string, date-time
      - `total_credits` integer
    - `running_at` string, date-time
    - `status` string
    - `tags` Tag[]
      - `key` string
      - `value` string
    - `team_id` string
    - `total_credits` integer
    - `ttl` string
    - `version` string
  - `error` string
  - `totalClusters` integer

## Other responses

- `400` — Returned on bad input
- `401` — Return if the caller is not authorized
- `403` — Returned if the caller does not have the needed permission
- `404` — Returned on resource not found

---

[API](https://skmtc.net/replicated/apis/vendor-api-v3-2.md) · [All operations](https://skmtc.net/replicated/apis/vendor-api-v3-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/replicated/vendor-api-v3-2/versions/6fcf9e54aba4/schema)