POST
/
v1
/
devboxes
/
{id}
/
shutdown
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const devboxView = await client.devboxes.shutdown('id');

  console.log(devboxView.id);
}

main();
{
  "id": "<string>",
  "name": "<string>",
  "status": "provisioning",
  "create_time_ms": 123,
  "end_time_ms": 123,
  "blueprint_id": "<string>",
  "snapshot_id": "<string>",
  "metadata": {},
  "failure_reason": "out_of_memory",
  "shutdown_reason": "api_shutdown",
  "launch_parameters": {
    "launch_commands": [
      "<string>"
    ],
    "resource_size_request": "X_SMALL",
    "keep_alive_time_seconds": 123,
    "available_ports": [
      123
    ],
    "after_idle": {
      "idle_time_seconds": 123,
      "on_idle": "shutdown"
    },
    "custom_cpu_cores": 123,
    "custom_gb_memory": 123,
    "architecture": "x86_64",
    "user_parameters": {
      "username": "<string>",
      "uid": 123
    }
  },
  "capabilities": [
    "unknown"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The Devbox ID.

Response

200 - application/json
OK

A Devbox represents a virtual development environment. It is an isolated sandbox that can be given to agents and used to run arbitrary code such as AI generated code.