Skip to main content
POST
/
v2
/
sandboxes
/
boxes
/
{name}
/
start
Error
A valid request URL is required to generate request examples
{
  "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,
  "mount_config": {
    "auth": {
      "aws": {
        "access_key_id": {
          "is_set": true,
          "value": "<string>"
        },
        "secret_access_key": {
          "is_set": true,
          "value": "<string>"
        }
      },
      "gcp": {
        "service_account_json": {
          "is_set": true,
          "value": "<string>"
        }
      }
    },
    "mounts": [
      {
        "id": "<string>",
        "mount_path": "<string>",
        "s3": {
          "bucket": "<string>",
          "endpoint_url": "<string>",
          "region": "<string>",
          "path_style": true,
          "prefix": "<string>"
        },
        "type": "s3",
        "cache": {
          "max_size_bytes": 1,
          "writeback_seconds": 1
        },
        "read_only": true,
        "gcs": {
          "bucket": "<string>",
          "prefix": "<string>"
        },
        "git": {
          "remote_url": "<string>",
          "ref": {
            "name": "<string>"
          },
          "refresh_interval_seconds": 2
        }
      }
    ]
  },
  "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": [
      {
        "name": "<string>",
        "aws": {
          "access_key_id": {
            "is_set": true,
            "value": "<string>"
          },
          "secret_access_key": {
            "is_set": true,
            "value": "<string>"
          }
        },
        "enabled": true,
        "gcp": {
          "scopes": [
            "<string>"
          ],
          "service_account_json": {
            "is_set": true,
            "value": "<string>"
          }
        },
        "headers": [
          {
            "name": "<string>",
            "is_set": true,
            "value": "<string>"
          }
        ],
        "match_hosts": [
          "<string>"
        ],
        "match_paths": [
          "<string>"
        ],
        "type": "<string>"
      }
    ]
  },
  "size_class": "<string>",
  "snapshot_id": "<string>",
  "status": "<string>",
  "status_message": "<string>",
  "stopped_at": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>",
  "vcpus": 123
}

Authorizations

X-API-Key
string
header
required

Path Parameters

name
string
required

Sandbox display name

Response

Accepted

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
mount_config
object
name
string
proxy_config
object
size_class
string
snapshot_id
string
status
string
status_message
string
stopped_at
string
updated_at
string
updated_by
string
vcpus
integer