POST
/
boxes
/
{boxId}
/
stop
JavaScript
import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.get("88714ae8-758f-4a4b-af96-20bcbb9d057d");

  await box.stop();

  console.log(`Box stopped: ${JSON.stringify(box.status)}`);
}

main();
{
  "id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
  "status": "running",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z",
  "expiresAt": "2024-01-15T10:40:00.000Z",
  "type": "linux",
  "config": {
    "os": {
      "version": "ubuntu-20.04"
    },
    "workingDir": "/home/user",
    "labels": {
      "environment": "development",
      "team": "qa"
    },
    "envs": {
      "NODE_ENV": "production",
      "PATH": "/usr/bin:/bin"
    },
    "cpu": 2,
    "memory": 1024,
    "storage": 30
  }
}

Authorizations

Authorization
string
header
required

Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai

Path Parameters

boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

Body

application/json

Configuration for box operation waiting behavior

Response

200 - application/json

Linux box instance with full configuration and status