Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
Box

Stop box

post/boxes/{boxId}/stop

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

waitboolean

Wait for the box operation to be completed, default is true

Example request

{
  "wait": true
}

Response

OR

Example response

{
  "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",
  "reason": "Box terminated by user",
  "type": "linux",
  "config": {
    "os": {
      "version": "ubuntu-20.04"
    },
    "workingDir": "/home/user",
    "labels": {
      "project": "web-scraper",
      "environment": "production",
      "team": "backend",
      "version": "v1.2.0"
    },
    "envs": {
      "MY_ENV_KEY": "env value"
    },
    "cpu": 2,
    "memory": 1024,
    "storage": 30,
    "publicIp": "8.8.8.8",
    "deviceType": "container"
  }
}