---
title: "List Clusters"
method: GET
path: "/api/admin/clusters"
tags: ["admin-clusters"]
---

# List Clusters

`GET /api/admin/clusters`

List non-terminated clusters (auto-scoped to the caller's grants).

## Query parameters

- `vaultEnabled` boolean, nullable — If true, return only vault-enabled clusters; if false, only non-vault-enabled. Omit to include both.
- `search` string, nullable — Case-insensitive substring match against cluster name or id.
- `offset` integer — Number of items to skip.
- `limit` integer — Max items to return (1-100).
- `detailed` boolean — If true, populate `nodes` for each cluster (one entry per pod). Otherwise only the `controller` connection is returned.

## Response `200`

Successful Response

- GenericPaginationResponseListAdminClusterSummary
  - `total_count` integer — Total number of items available in the dataset
  - `offset` integer — Number of items to skip before starting to collect the result set
  - `limit` integer — Maximum number of items to return
  - `data` AdminClusterSummary[], required
    - `id` string, required
    - `name` string, required
    - `providerType` string, required
    - `status` string, required
    - `vaultEnabled` boolean, required
    - `teamId` string, nullable
    - `userId` string, nullable
    - `createdAt` string, date-time, required
    - `controller` ClusterNodeConnection — Connection details for a single cluster pod/node.
      - `podId` string, required
      - `podName` string, nullable
      - `host` string, required
      - `port` integer
      - `user` string, required
      - `role` string, nullable
      - `isControlNode` boolean
    - `nodes` ClusterNodeConnection[], nullable — All node connection details. Only populated when ?detailed=true.
      - `podId` string, required
      - `podName` string, nullable
      - `host` string, required
      - `port` integer
      - `user` string, required
      - `role` string, nullable
      - `isControlNode` boolean
  - `status` string, nullable — Response status

## Other responses

- `401` — Authorization failed
- `403` — Insufficient permissions
- `422` — Invalid request data

---

[API](https://skmtc.net/primeintellect/apis/pi-api.md) · [All operations](https://skmtc.net/primeintellect/apis/pi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/primeintellect/pi-api/revisions/3d3868828a78/schema)