Update a sandbox

Update a sandbox’s display name. The name must be unique within the tenant.

PATCH /v2/sandboxes/boxes/{name}

Error

A valid request URL is required to generate request examples

200

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

Path Parameters

name · string · required

Current sandbox display name

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

tag_value_ids · string[]

vcpus · integer

Response

200

application/json

OK

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