E2e2b-dev
admin

Terminate an instance of a rig

Changed on

Terminate an instance in whichever rig's scaling group it belongs to. The caller chooses whether the rig shrinks or the instance is replaced.

delete/clusters/{clusterID}/rigs/instances/{instanceID}

Request

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

Path parameters

clusterIDstring uuid required

Identifier of the cluster

instanceIDstring required

Provider instance ID

Query parameters

decrementDesiredboolean required

When true, desired capacity is decremented (rig shrinks); when false, the scaling group launches a replacement instance

Response

Instance termination accepted

Changes