List sandboxes

get https://{hostname}/sandbox-api/v1/sandboxes

Get a list of sandboxes. The response includes the sandboxId, identifies who created the sandbox, the sandbox name, and the X-Limit-Sandboxes-Remaining in the response header indicating the number of remaining sandboxes you can create. If your Control Center user role has permission to edit Property Manager configurations, you can view all the sandboxes within the account. Then you're able to Delete a sandbox returned in the list. If your user role has permission to edit the property within your Property Manager configuration, you can Update a rule tree. For more information on user roles and permissions, refer to Identity and Access Management.

Response

Response body

object

_links

object

HAL-formatted hypermedia links relating to the sandbox. See Hypermedia for more information.

Has additional fields

accountId

string

required

Unique identifier for an account.

sandboxes

array of objects

required

The set of sandboxes created by the developer.

sandboxes*

object

_links

object

HAL-formatted hypermedia links relating to the sandbox. See Hypermedia for more information.

Has additional fields

createdBy

string

required

The identifier for the developer who created the sandbox.

createdOn

date-time

required

A timestamp when the system created the sandbox.

isClonable

boolean

required

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

jwtToken

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.

name

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.

properties

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*

object

_links

object

HAL-formatted hypermedia links relating to the sandbox's properties. See Hypermedia for more information.

Has additional fields

additionalRequestHostnamesInProperty

array of strings

Hostnames assigned to the property referenced in the Create a sandbox request and not included as request hostnames in the JSON body.

additionalRequestHostnamesInProperty

editedRuleBehaviors

array of strings

Behaviors in the rule tree that were modified for use in the Sandbox.

editedRuleBehaviors

filteredRuleBehaviors

array of strings

Behaviors in the rule tree that were removed because they aren't supported by Sandbox.

filteredRuleBehaviors

requestHostnames

array of strings

A set of hostnames you can use for testing requests within your sandbox.

requestHostnames

sandboxPropertyId

string

The unique identifier for the sandbox.

validationWarnings

array of objects

Warnings from validating the rule tree when a sandbox exists or a property is added. For details, refer to Errors.

validationWarnings

object

detail

string

Read-only Provides specific information related to this validation warning.

errorLocation

string

Read-only Provides a path expression to the offending rule.

instance

string

Read-only A unique identifier for this particular validation.

type

string

Read-only A unique name for this particular validation.

sandboxId

string

required

The unique identifier for the sandbox.

status

string

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

statusReason

string

Provides more information when the status field is ERROR.

Headers

object

X-Limit-Sandboxes-Limit

integer

The total number of sandboxes you can create.

X-Limit-Sandboxes-Remaining

integer

The number of remaining sandboxes you can create.

200Successful operation.