E2e2b-dev
admin

List the instances attached to a rig

Changed on

List the instances attached to the rig's scaling group with their creation time and transition state, sorted by instance ID.

get/clusters/{clusterID}/rigs/{rigID}/instances

Request

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

Path parameters

clusterIDstring uuid required

Identifier of the cluster

rigIDstring required

Rig identifier (e.g. "default")

Response

Successfully returned the instances of the rig

idstring required

Provider instance ID (EC2 instance ID on AWS, instance name on GCP), also the node ID the orchestrator reports

createdAtstring date-time

When the provider created the instance. Omitted while the instance is transitioning.

transitioningboolean required

The provider is creating, deleting, recreating or otherwise mutating the instance

terminatingboolean required

The instance is on its way out of the group and can never become healthy again

Changes