---
title: "List rigs of a cluster"
method: GET
path: "/clusters/{clusterID}/rigs"
tags: ["admin"]
---

# List rigs of a cluster

`GET /clusters/{clusterID}/rigs`

## Request

- Base URL: `https://api.e2b.app`
- URL: `https://api.e2b.app/clusters/{clusterID}/rigs`
- Auth: one of:
  - API key in header `X-Admin-Token`
  - HTTP bearer

List the orchestrator node pools ("rigs") of a cluster with a snapshot of their scaling groups. Forwarded to the cluster's edge service; a cluster with no rig management configured returns an empty list, and the local cluster answers 501.

## Path parameters

- `clusterID` string, uuid, required

## Response `200`

Successfully returned the rigs of the cluster

- Rig[]
  - `id` string, required: Rig identifier (e.g. "default")
  - `provider` string, required: Cloud provider backing the rig ("aws" or "gcp")
  - `resourceID` string, required: Canonical cloud resource ID of the scaling group backing the rig (ARN on AWS, self-link on GCP)
  - `capacityDesired` integer, required: Desired number of instances in the rig
  - `capacityMin` integer: Minimum capacity enforced on the rig's scaling group. Omitted when nothing enforces bounds (GCP MIG without an active autoscaler).
  - `capacityMax` integer: Maximum capacity enforced on the rig's scaling group. Omitted when nothing enforces bounds (GCP MIG without an active autoscaler).
  - `capacityCurrent` integer, required: Number of instances currently attached to the rig

## Other responses

- `401`: Authentication error
- `404`: Not found
- `429`: Too many requests
- `500`: Server error
- `501`: Not implemented by this deployment

## Changes

- **2026-09-14** `a37f50c70019`: 1 info
  - added the non-success response with the status `429`
- **2026-09-07** `fc7dc26a953d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/e2b-dev/apis/e2b-api/changes/clusters/:clusterID/rigs/get.md)

---

[API](https://skmtc.dev/e2b-dev/apis/e2b-api.md) - [All operations](https://skmtc.dev/e2b-dev/apis/e2b-api/llms.txt) - [OpenAPI document](https://skmtc.dev/e2b-dev/apis/e2b-api/revisions/99fccbc60e6d?raw)