Create a sandbox

Create a new sandbox from a snapshot. Provide at most one of snapshot_id or snapshot_name; if neither is provided, the server uses the default static blueprint.

POST /v2/sandboxes/boxes

Error

A valid request URL is required to generate request examples

201

{
  "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

Body

application/json

delete_after_stop_seconds · integer

fs_capacity_bytes · integer

idle_ttl_seconds · integer

mem_bytes · integer

name · string

proxy_config · object

Show child attributes

restore_memory · boolean

RestoreMemory, when non-nil, overrides the server default for whether to resume the sandbox from its captured memory snapshot.

true → resume from the memory snapshot if it exists; cold-boot the sandbox otherwise. false → always cold-boot, even if a memory snapshot exists. nil → use the server default.

Applies to this request only; a later stop+start of the same sandbox reverts to the server default.

snapshot_id · string

snapshot_name · string

tag_value_ids · string[]

vcpus · integer

Response

201

application/json

Created

created_at · string

created_by · string

dataplane_url · string

delete_after_stop_seconds · integer

fs_capacity_bytes · integer

id · string

idle_ttl_seconds · integer

mem_bytes · integer

name · string

proxy_config · object

Show child attributes

size_class · string

snapshot_id · string

status · string

status_message · string

stopped_at · string

updated_at · string

updated_by · string

vcpus · integer