Sign in
sandboxes

Update a Sandbox resource.

Changed on

Replaces the mutable configuration for an existing Sandbox. The name in the path identifies the Sandbox.

put/api/sandbox/{sandboxName}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/sandbox/{sandboxName}
  • Auth: HTTP bearer

Path parameters

sandboxNamestring required

Sandbox resource name.

Headers

X-AgentZ-Workspace-IDstring

Stable Workspace ID selecting Workspace scope. Omit for Organisation scope.

Request body

packagesstring[] required
allowed_hostsstring[] required

Response

Sandbox updated.

namestring required

Sandbox resource name.

scope'Organisation' | 'Workspace' required
packagesstring[] required
allowed_hostsstring[] required
can_modifyboolean required
can_deleteboolean required
created_atstring date-time required

Changes

  • f9e13a5159d6Revision changes
    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      the / request property type changed from string to object

    • breaking

      the / response property's maxLength was unset from 32 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response's property type changed from string to object for status

    • info

      the endpoint scheme security GatewayBearer was added to the API

    • info

      added the new optional header request parameter X-AgentZ-Workspace-ID

    • info

      the / request property's minLength was decreased from 1 to 0

    • info

      removed the pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ from the request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the / response's property pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ was removed for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 5256a5fade28Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status