sandboxes

Update a sandbox

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

patch/v2/sandboxes/boxes/{name}

Path parameters

namestring required

Current sandbox display name

Request body

delete_after_stop_secondsinteger
fs_capacity_bytesinteger
idle_ttl_secondsinteger
mem_bytesinteger
namestring
tag_value_idsstring[]
vcpusinteger

Response

OK

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 9 of the 48 revisions of this API.3735

  • a0acb3a6a101312See the full diff
    • removed the request property ttl_seconds

      request-property-removed

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

      response-optional-property-removed

    • removed the optional property ttl_seconds from the response with the 200 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 tag_value_ids

      new-optional-request-property

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

      response-optional-property-added

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

      response-optional-property-added

    • added the optional property detail/error_id to the response with the 404 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 500 status

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    • added the optional property updated_by to the response with the 200 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

  • 99490d1e837e13See the full diff
    • removed the optional property template_name from the response with the 200 status

      response-optional-property-removed

    • added the new optional request property proxy_config/callbacks

      new-optional-request-property

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

      response-optional-property-added

    • added the optional property size_class to the response with the 200 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

  • e86be67718ee1110See the full diff
    • removed the required property proxy_config/rules/items/inject_headers from the response with the 200 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 vcpus

      new-optional-request-property

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    • 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 200 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 200 status

      response-optional-property-added

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

      response-optional-property-added

    • removed the request property proxy_config

      request-property-removed

    • removed the optional property proxy_config from the response with the 200 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 new optional request property proxy_config/access_control

      new-optional-request-property

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

      response-optional-property-added

  • 59a955354a0121See the full diff
    • the response property proxy_config/rules became optional for the status 200

      response-property-became-optional

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

      response-property-min-items-decreased

    • the request property proxy_config/rules became optional

      request-property-became-optional

    • added the new optional request property proxy_config

      new-optional-request-property

    • added the optional property proxy_config to the response with the 200 status

      response-optional-property-added