List Devboxes.

Authorizations

Authorization

string

header

required

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

Query Parameters

status

enum<string>

Filter by status

Available options:

provisioning,

initializing,

running,

suspending,

suspended,

resuming,

failure,

shutdown

limit

integer

The limit of items to return. Default is 20.

starting_after

string

Load the next page of data starting after the item with the given ID.

Response

200 - application/json

devboxes

object[]

required

List of devboxes matching filter.

devboxes.capabilities

enum<string>[]

required

A list of capability groups this devbox has access to. This allows devboxes to be compatible with certain tools sets like computer usage APIs.

Available options:

unknown,

computer_usage,

browser_usage,

language_server

devboxes.create_time_ms

integer

required

Creation time of the Devbox (Unix timestamp milliseconds).

devboxes.id

string

required

The ID of the Devbox.

devboxes.launch_parameters

object

required

The launch parameters used to create the Devbox.

devboxes.metadata

object

required

The user defined Devbox metadata.

devboxes.status

enum<string>

required

The current status of the Devbox.

Available options:

provisioning,

initializing,

running,

suspending,

suspended,

resuming,

failure,

shutdown

devboxes.blueprint_id

string | null

The Blueprint ID used in creation of the Devbox, if the devbox was created from a Blueprint.

devboxes.end_time_ms

integer | null

The time the Devbox finished execution (Unix timestamp milliseconds). Present if the Devbox is in a terminal state.

devboxes.failure_reason

enum<string>

The failure reason if the Devbox failed, if the Devbox has a 'failure' status.

Available options:

out_of_memory,

out_of_disk,

execution_failed

devboxes.name

string | null

The name of the Devbox.

devboxes.shutdown_reason

enum<string>

The shutdown reason if the Devbox shutdown, if the Devbox has a 'shutdown' status.

Available options:

api_shutdown,

keep_alive_timeout,

entrypoint_exit,

idle,

lambda_lifecycle

devboxes.snapshot_id

string | null

The Snapshot ID used in creation of the Devbox, if the devbox was created from a Snapshot.

has_more

boolean

required

total_count

integer

required

API Reference

Blueprint

Devbox

Repository

Authorizations

Query Parameters

Response