Add a property to a sandbox

post

https://{hostname}/sandbox-api/v1/sandboxes/{sandboxId}/properties

You can add a property to a sandbox. Use this if you need to support more than one hostname in your sandbox environment.

Path Params

sandboxId

string

required

Unique identifier for the sandbox.

Query Params

accountSwitchKey

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

Create a JSON request body for the sandbox property.

contractId

string

The identifier you can use to create a sandbox from a specific contract. If you use this, you also need to specify the groupId.

cpcode

number

Unique code you use to isolate sandbox traffic in report data. If you don't specify a value, the system creates one.

edgeHostname

string

The edge hostname for the property as configured in Property Manager. May be specified instead of propertyId, hostname, or propertyName.

groupId

string

The identifier you can use to create a sandbox from a specific group. If you use this, you also need to specify the contractId.

hostname

string

The hostname for the property as configured in Property Manager. May be specified instead of propertyId, edgeHostname, or propertyName.

propertyId

string

The unique identifier for the property as it appears in Property Manager. May be specified instead of hostname, edgeHostname, or propertyName.

propertyName

string

The name of the property as it appears in Property Manager. May be specified instead of propertyId, edgeHostname, or hostname.

propertyVersion

number

Specifies the version, otherwise the API uses the version active in production. If an active version isn't found, the API uses the most recent version.

requestHostnames

array of strings

Specifies the hostnames for the request. If you try to create a sandbox property with a requestHostname that isn't already contained in the property configuration, you may get unexpected results. The Sandbox API automatically converts any specified request hostnames to lower case.

requestHostnames

ruleFormat

string

Specifies the rule format. The rule format is a dated version of the rule object in a property configuration. For more information, refer to the Property Manager API.

rules

object

Defines how your website and applications process requests and the behaviors to apply to those requests. Include a rules object if you want to apply specific rules to test within your sandbox. The content-handling rules are defined in the Property Manager API.

Response

201The resource was created.