# List the organization's Sandboxes across providers: running, paused, lost and deleted, with filters.

Source: <https://everruns.com/docs/api/operations/list_sandboxes/>

GET

/v1/sandboxes

Select code samplecURL (shell:curl)

```js
const url = 'https://app.everruns.com/api/v1/sandboxes';
const options = {method: 'GET'};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```sh
curl --request GET \
  --url https://app.everruns.com/api/v1/sandboxes
```

* Production APIapp.everruns.com/api/v1/sandboxes

## Parameters

### Query Parameters

**state**

string

Comma-separated states: `running`, `paused`, `lost`, `starting`, `failed`, `not_started`, `deleted`, or `live` for the first five.

**provider**

string

Comma-separated provider ids, such as `daytona,modal`.

**agent\_id**

string

Only Sandboxes of Sessions that ran this Agent.

**sandbox\_template\_id**

string

Only Sandboxes created from this Sandbox Template.

**needs\_attention**

boolean

Only Sandboxes with at least one attention reason.

**search**

string

Case-insensitive match on Session title, Agent, provider or provider resource id.

**include\_in\_process**

boolean

Include in-process targets (virtual filesystem, host), which have no provider resource.

**limit**

integer format: int64

Page size, 1 to 200. Defaults to 50.

**offset**

integer format: int64

Rows to skip.

## Responses

### 200

Success

Media typeapplication/json

A page of the fleet.

object

**items**

required

Array\<object>

One logical Sandbox in the organization.

object

**agent\_id**

Agent the Session ran.

string | null

**agent\_name**

Agent display name.

string | null

**attention**

required

Why this Sandbox needs attention: `lost`, `failed`, `init_failed`, `idle_running` (running with no activity for an hour) or `cleanup_failed`.

Array\<string>

**checkpoint\_count**

required

Committed workspace checkpoints.

integer format: int64

**created\_at**

required

string format: date-time

**deleted\_at**

string | null format: date-time

**desired\_state**

required

Lifecycle intent the control plane is moving the Sandbox toward: `ready`, `paused` or `deleted`.

string

**external\_id**

Provider’s id for the latest physical resource.

string | null

**generation**

required

Incarnation counter. Above 1 means the provider resource was lost and rebuilt.

integer format: int64

**id**

required

Durable logical Sandbox id. Stays the same when the provider resource is replaced.

string

**idle\_after\_seconds**

Inactivity interval before the Sandbox is paused.

integer | null format: int64

**last\_activity\_at**

Last recorded tool activity or state change.

string | null format: date-time

**last\_init\_error**

Error from the latest init commands, if they failed.

string | null

**provider**

required

Provider id, such as `daytona`, `modal` or `docker`.

string

**role**

required

`primary` (addressed implicitly by shell and file tools) or `resource`.

string

**session\_id**

Owning Session; absent once the Session is deleted.

string | null

**session\_title**

Session title, kept after the Session is deleted.

string | null

**state**

required

`running`, `paused`, `lost`, `starting`, `failed`, `not_started` or `deleted`.

string

**target\_kind**

Target kind from the pinned specification: `managed`, `container`, `machine`, `vfs` or `host`.

string | null

**template**

One of:

* object

  Template revision the Sandbox was created from.

  object

  **display\_name**

  Template display name.

  string | null

  **id**

  required

  Sandbox Template id.

  string

  **revision**

  Revision number pinned when the Session was created.

  integer | null format: int32

* null

  null

**updated\_at**

required

string format: date-time

**workspace\_path**

Working directory inside the Sandbox.

string | null

**limit**

required

integer format: int64

**offset**

required

integer format: int64

**total**

required

Sandboxes matching the filters.

integer format: int64

##### Example

```json
{
  "items": [
    {
      "agent_name": "Coder",
      "checkpoint_count": 12,
      "desired_state": "ready",
      "external_id": "dtn-7f3a91c2",
      "generation": 1,
      "id": "sandbox_01933b5a00007000800000000000001",
      "idle_after_seconds": 300,
      "provider": "daytona",
      "role": "primary",
      "session_title": "Fix flaky CI",
      "state": "running",
      "target_kind": "managed",
      "template": {
        "display_name": "Coding - Daytona",
        "id": "sbxtpl_01933b5a00007000800000000000001",
        "revision": 4
      },
      "workspace_path": "/home/daytona/workspace"
    }
  ]
}
```