Show Menu
TOPICS×

Create a sandbox

You can create a new sandbox by making a POST request to the /sandboxes endpoint.
API format
POST /sandboxes

Request
The following request creates a new development sandbox named "dev-3".
curl -X POST \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "dev-3",
    "title": "Development 3",
    "type": "development"
  }'

Property
Description
name
The identifier that will be used to access the sandbox in future requests. This value must be unique, and best practice is to make it as descriptive as possible. Cannot contain any spaces or capital letters.
title
A human-readable name used for display purposes in the Platform user interface.
type
The type of sandbox to be created. Currently only "development" type sandboxes can be created by an organization.
Response
A successful response returns the details of the newly created sandbox, showing that its state is "creating".
{
    "name": "dev-3",
    "title": "Development 3",
    "state": "creating",
    "type": "development",
    "region": "VA7"
}

Sandboxes take roughly 15 minutes to be provisioned by the system, after which their state will become "active" or "failed".