Skip to main content
GET
/
api
/
admin
/
clusters
List Clusters
curl --request GET \
  --url https://api.primeintellect.ai/api/admin/clusters \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "providerType": "<string>",
      "status": "<string>",
      "vaultEnabled": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "teamId": "<string>",
      "userId": "<string>",
      "controller": {
        "podId": "<string>",
        "host": "<string>",
        "user": "<string>",
        "podName": "<string>",
        "port": 22,
        "role": "<string>",
        "isControlNode": false
      },
      "nodes": [
        {
          "podId": "<string>",
          "host": "<string>",
          "user": "<string>",
          "podName": "<string>",
          "port": 22,
          "role": "<string>",
          "isControlNode": false
        }
      ]
    }
  ],
  "total_count": 0,
  "offset": 0,
  "limit": 100,
  "status": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

vaultEnabled
boolean | null

If true, return only vault-enabled clusters; if false, only non-vault-enabled. Omit to include both.

search
string | null

Case-insensitive substring match against cluster name or id.

offset
integer
default:0

Number of items to skip.

Required range: x >= 0
limit
integer
default:20

Max items to return (1-100).

Required range: 1 <= x <= 100
detailed
boolean
default:false

If true, populate nodes for each cluster (one entry per pod). Otherwise only the controller connection is returned.

Response

Successful Response

data
AdminClusterSummary · object[]
required
total_count
integer
default:0

Total number of items available in the dataset

offset
integer
default:0

Number of items to skip before starting to collect the result set

Required range: x >= 0
limit
integer
default:100

Maximum number of items to return

Required range: x >= 0
status
string | null

Response status