API

Create a sandbox

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

You can create a sandbox based on an existing property, hostname, or property version. Refer to the examples in the Recipes. In order to create a sandbox with this method, you need to have an API client for the Sandbox API with read-write access and Property Manager authorization enabled in Control Center.

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

Create a JSON request body including data members as described in the table below.

boolean
Defaults to false

Indicates whether the sandbox can be cloned by other developers.

string

Descriptive name for the new sandbox. Specify a name, otherwise it's the sandboxId value by default. If the name isn't unique, you get an error message.

property
object
required

Contains information about the property within the sandbox.

Response

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago