Enable isClonable if you preconfigured the settings for the sandbox. It allows other developers to create an exact replica in their development environment. You can also update the sandbox name to identify it when returned in a list or in a log line.

Path Params
string
required

Unique identifier for the sandbox.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
object
string
required

The identifier for the developer who created the sandbox.

date-time
required

A timestamp when the system created the sandbox.

boolean
required

Indicates whether the sandbox can be copied for another developer's use.

string

Java Web Token returned in the JSON response when you create a sandbox and used for authentication. Use this string value to configure the Sandbox Client.

string
required

The name of the sandbox defined by the developer when the sandbox was created. If you don't specify a name, the default is the sandboxId.

array of objects
required

A list of the properties available for testing in the sandbox environment. A sandbox can contain more than one property, but a given hostname may only be associated to one property within a sandbox.

properties*
string
required

The unique identifier for the sandbox.

string

The status of the sandbox. OK indicates that the sandbox is able to send traffic.

string

Provides more information when the status field is ERROR.

Response
204

The request was successfully processed.

Language
Authentication
URL
Click Try It! to start a request and see the response here!