Clone a preconfigured sandbox

Quickly set up a sandbox in your development environment based on preconfigured settings.

Before you begin

To create a sandbox this way, you need to have the sandboxID for a clonable sandbox.

Use this method if you want to create a replica of a sandbox that was preconfigured by another developer within your organization.
Note: The developer may provide you with the href link in this form:
"href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/clone"
Otherwise, use the clone endpoint as explained below.

How to

  1. Get the sandboxId for a clonable sandbox.
  2. Issue a POST request.
    /sandbox-api/v1/sandboxes/{sandboxId}/clone
    Note important information about your sandbox included in the response body.
    {
        "sandboxId": "2956607f-854e-11e8-898a-0242ac110002",
        "createdBy": "joe@example.com",
        "createdOn": "2018-10-09T15:20:36.441Z",
        "name": "Sandbox-123",
        "jwtToken": "eyJ0eXA ... qggqqw",
        "isClonable": true,
        "status": "OK",
        "properties": [
            {
                "sandboxPropertyId": "e7b77afe-271b-4159-bdd1-c312ef560cdb",
                "requestHostnames": [
                    "foo.exampledevops.com",
                    "foobar.abc1234def.com"
                ],
                "additionalRequestHostnamesInProperty": [
                    "www.abc1234def.com"
                ],
                "_links": {
                    "property": {
                        "href": "/sandbox-api/v1/sandboxes/75496b3f-6ec0-46dd-9c7e-480d6c201a0d/properties/e7b77afe-271b-4159-bdd1-c312ef560cdb"
                    },
                    "rules": {
                        "href": "/sandbox-api/v1/sandboxes/75496b3f-6ec0-46dd-9c7e-480d6c201a0d/properties/e7b77afe-271b-4159-bdd1-c312ef560cdb/rules"
                    }
                }
            }
        ],
        "_links": {
            "self": {
                "href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002"
            },
            "rotateJWT": {
                "href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/rotateJWT"
            },
            "clone": {
                "href": "/sandbox-api/v1/sandboxes/2956607f-854e-11e8-898a-0242ac110002/clone"
            }
        }
    }
    You can use the links to perform actions on the sandbox.

Next steps

Copy the jwtToken in the response object. You need this to configure Sandbox Client.
Note: The jwtToken is valid for thirty days. To generate a new one, rotate the JWT.