sandboxes

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

Request body

delete_after_stop_secondsinteger
fs_capacity_bytesinteger
idle_ttl_secondsinteger
mem_bytesinteger
namestring
restore_memoryboolean

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_idstring
snapshot_namestring
tag_value_idsstring[]
vcpusinteger

Response

Created

created_atstring
created_bystring
dataplane_urlstring
delete_after_stop_secondsinteger
fs_capacity_bytesinteger
idstring
idle_ttl_secondsinteger
mem_bytesinteger
namestring
size_classstring
snapshot_idstring
statusstring
status_messagestring
stopped_atstring
updated_atstring
updated_bystring
vcpusinteger

Changes

Changed in 11 of the 48 revisions of this API.3940

  • a0acb3a6a101316See the full diff
    • removed the request property ttl_seconds

      request-property-removed

    • removed the optional property expires_at from the response with the 201 status

      response-optional-property-removed

    • removed the optional property ttl_seconds from the response with the 201 status

      response-optional-property-removed

    • added the new optional request property delete_after_stop_seconds

      new-optional-request-property

    • added the new optional request property proxy_config/callbacks/items/full_request

      new-optional-request-property

    • added the new optional request property restore_memory

      new-optional-request-property

    • added the new optional request property tag_value_ids

      new-optional-request-property

    • added the non-success response with the status 504

      response-non-success-status-added

    • removed the non-success response with the status 408

      response-non-success-status-removed

    • added the optional property created_by to the response with the 201 status

      response-optional-property-added

    • added the optional property delete_after_stop_seconds to the response with the 201 status

      response-optional-property-added

    • added the optional property detail/error_id to the response with the 400 status

      response-optional-property-added

    • added the optional property detail/error_id to the response with the 409 status

      response-optional-property-added

    • added the optional property detail/error_id to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/error_id to the response with the 429 status

      response-optional-property-added

    • added the optional property detail/error_id to the response with the 500 status

      response-optional-property-added

    • added the optional property proxy_config/callbacks/items/full_request to the response with the 201 status

      response-optional-property-added

    • added the optional property stopped_at to the response with the 201 status

      response-optional-property-added

    • added the optional property updated_by to the response with the 201 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the request property timeout

      request-property-removed

    • removed the request property wait_for_ready

      request-property-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 99490d1e837e24See the full diff
    • removed the request property template_name

      request-property-removed

    • removed the optional property template_name from the response with the 201 status

      response-optional-property-removed

    • added the new optional request property proxy_config/callbacks

      new-optional-request-property

    • added the new optional request property snapshot_name

      new-optional-request-property

    • added the optional property proxy_config/callbacks to the response with the 201 status

      response-optional-property-added

    • added the optional property size_class to the response with the 201 status

      response-optional-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e86be67718ee1112See the full diff
    • removed the required property proxy_config/rules/items/inject_headers from the response with the 201 status

      response-required-property-removed

    • removed the request property proxy_config/rules/items/inject_headers

      request-property-removed

    • the endpoint scheme security X-Service-Key was added to the API

      api-security-added

    • added the new optional request property fs_capacity_bytes

      new-optional-request-property

    • added the new optional request property mem_bytes

      new-optional-request-property

    • added the new optional request property proxy_config/rules/items/headers

      new-optional-request-property

    • added the new optional request property snapshot_id

      new-optional-request-property

    • added the new optional request property vcpus

      new-optional-request-property

    • the request property template_name became optional

      request-property-became-optional

    • added the optional property fs_capacity_bytes to the response with the 201 status

      response-optional-property-added

    • added the optional property mem_bytes to the response with the 201 status

      response-optional-property-added

    • added the optional property proxy_config/rules/items/headers to the response with the 201 status

      response-optional-property-added

    • added the optional property snapshot_id to the response with the 201 status

      response-optional-property-added

    • added the optional property vcpus to the response with the 201 status

      response-optional-property-added

    • added the new optional request property proxy_config

      new-optional-request-property

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property idle_ttl_seconds

      new-optional-request-property

    • added the optional property idle_ttl_seconds to the response with the 201 status

      response-optional-property-added

    • added the new optional request property ttl_seconds

      new-optional-request-property

    • added the optional property expires_at to the response with the 201 status

      response-optional-property-added

    • added the optional property ttl_seconds to the response with the 201 status

      response-optional-property-added

    • removed the optional property proxy_config from the response with the 201 status

      response-optional-property-removed

    This revision also has 25 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property proxy_config/access_control to the response with the 201 status

      response-optional-property-added

    • the response property proxy_config/rules became optional for the status 201

      response-property-became-optional

    • the proxy_config/rules response property's minItems was decreased from 1 to 0 for the response status 201

      response-property-min-items-decreased