List sandboxes

List sandboxes for the authenticated tenant, with optional filtering, sorting, and pagination.

GET /v2/sandboxes/boxes

Error

A valid request URL is required to generate request examples

200

{
  "offset": 123,
  "sandboxes": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "dataplane_url": "<string>",
      "delete_after_stop_seconds": 123,
      "fs_capacity_bytes": 123,
      "id": "<string>",
      "idle_ttl_seconds": 123,
      "mem_bytes": 123,
      "name": "<string>",
      "proxy_config": {
        "access_control": {
          "allow_list": [
            "<string>"
          ],
          "deny_list": [
            "<string>"
          ]
        },
        "callbacks": [
          {
            "match_hosts": [
              "<string>"
            ],
            "ttl_seconds": 1830,
            "url": "<string>",
            "full_request": true,
            "request_headers": [
              {
                "name": "<string>",
                "is_set": true,
                "value": "<string>"
              }
            ]
          }
        ],
        "no_proxy": [
          "<string>"
        ],
        "rules": [
          {
            "match_hosts": [
              "<string>"
            ],
            "name": "<string>",
            "enabled": true,
            "headers": [
              {
                "name": "<string>",
                "is_set": true,
                "value": "<string>"
              }
            ],
            "match_paths": [
              "<string>"
            ]
          }
        ]
      },
      "size_class": "<string>",
      "snapshot_id": "<string>",
      "status": "<string>",
      "status_message": "<string>",
      "stopped_at": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>",
      "vcpus": 123
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Query Parameters

limit · integer · default: 50

Maximum number of results

offset · integer · default: 0

Pagination offset

name_contains · string

Filter by name substring

status · string

Filter by status (provisioning, ready, failed, stopped, deleting)

sort_by · string · default: created_at

Sort column (name, status, created_at)

sort_direction · string · default: desc

Sort direction (asc, desc)

Response

200

application/json

OK

offset · integer

sandboxes · object[]

Show child attributes