E2e2b-dev
admin

List rigs of a cluster

Changed on

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.

get/clusters/{clusterID}/rigs

Request

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

Path parameters

clusterIDstring uuid required

Identifier of the cluster

Response

Successfully returned the rigs of the cluster

idstring required

Rig identifier (e.g. "default")

providerstring required

Cloud provider backing the rig ("aws" or "gcp")

resourceIDstring required

Canonical cloud resource ID of the scaling group backing the rig (ARN on AWS, self-link on GCP)

capacityDesiredinteger required

Desired number of instances in the rig

capacityMininteger

Minimum capacity enforced on the rig's scaling group. Omitted when nothing enforces bounds (GCP MIG without an active autoscaler).

capacityMaxinteger

Maximum capacity enforced on the rig's scaling group. Omitted when nothing enforces bounds (GCP MIG without an active autoscaler).

capacityCurrentinteger required

Number of instances currently attached to the rig

Changes