Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Sandbox API (1.0)

Download OpenAPI specification:Download

Adobe Experience Platform provides virtual sandbox environments which provide isolation and access control for Platform integrations. Use sandboxes for application lifecycle management, project management, and to build customized development ecosystems.

  • Related documentation:

  • Visualize API calls with Postman (a free, third-party software):

  • API paths:

    • PLATFORM Gateway URL: https://platform.adobe.io/
    • Base path for this API: /data/foundation/sandbox-management
    • Example of a complete path: https://platform.adobe.io/data/foundation/sandbox-management/sandboxes

  • Required headers:

    • All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.
    • All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header x-sandbox-name whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the sandboxes overview for more information.
    • All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header Content-Type with a value of application/json.

  • API error handling:

  • Filtering responses:

    • When performing listing (GET) requests in the Sandbox API, you can use query parameters to filter responses.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Admin operations

Sandbox operations available only to admins. Sandbox admin privileges are managed through the Adobe Admin Console.

List all supported sandbox types

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

get/sandboxTypes
Response samples
application/json
{
  • "sandboxTypes": [
    ]
}

List sandboxes

This endpoint lists all the sandboxes that belong to your IMS Organization.

Request
query Parameters
property
string

Regex used to filter objects in the response. For example: "property=name==test."

orderBy
string

Parameter used to identify a property to order listed responses by, including sort direction ("asc:" for ascending, "desc:" for descending). For example, "orderBy=asc:created,updated".

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

get/sandboxes
Response samples
application/json
{
  • "sandboxes": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}

Create a sandbox

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/json

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Request Body schema: application/json
required

JSON payload that outlines the details of the sandbox to be created.

name
required
string
title
required
string
type
required
string
Enum: "production" "development"
Responses
202

Success

400

Bad request

403

Missing access permissions

409

Conflict

500

Internal server error

post/sandboxes
Request samples
application/json
{
  • "name": "my-dev-sandbox",
  • "title": "My Dev Sandbox",
  • "type": "development"
}
Response samples
application/json
{
  • "id": "180e1210-d33a-11e9-8b17-d9e538719ued",
  • "name": "acme-sandbox",
  • "title": "ACME Sandbox",
  • "state": "creating",
  • "type": "development",
  • "region": "VA7"
}

Retrieve a sandbox

You can use this endpoint to retrieve a sandbox by name.

Request
path Parameters
sandboxName
required
string

The name of a sandbox, used as an identifier.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

get/sandboxes/{sandboxName}
Response samples
application/json
{
  • "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  • "name": "acme-sandbox",
  • "title": "ACME Sandbox",
  • "state": "active",
  • "type": "development",
  • "region": "VA7",
  • "isDefault": true,
  • "etag": 1,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "",
  • "modifiedBy": "",
  • "_system": {
    }
}

Reset a sandbox

You can use this endpoint to reset a sandbox, as specified by the name.

Request
path Parameters
sandboxName
required
string

The name of a sandbox, used as an identifier.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

Content-Type
required
string

application/json

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Request Body schema: application/json
required

Reset Sandbox

action
required
string
Responses
202

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

put/sandboxes/{sandboxName}
Request samples
application/json
{
  • "action": "reset"
}

Delete a sandbox

You can use this endpoint to delete a sandbox by name.

Request
path Parameters
sandboxName
required
string

The name of a sandbox, used as an identifier.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Responses
202

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

delete/sandboxes/{sandboxName}
Response samples
application/json
{
  • "id": "180e1210-d33a-11e9-8b17-d9e538719ued",
  • "name": "acme-sandbox",
  • "title": "ACME Sandbox",
  • "state": "cleaning",
  • "type": "development",
  • "region": "VA7"
}

Update a sandbox

You can use this endpoint to update a sandbox, as specified by the name.

Request
path Parameters
sandboxName
required
string

The name of a sandbox, used as an identifier.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

application/json

x-sandbox-name
required
string

The name of the sandbox in which the operation will take place. See the sandboxes overview documentation for more information.

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Request Body schema: application/json
required

JSON payload outlining the sandbox properties to be updated, along with their new values.

title
required
string
Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

patch/sandboxes/{sandboxName}
Request samples
application/json
{
  • "title": "My Sandbox"
}
Response samples
application/json
{
  • "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  • "name": "acme-sandbox",
  • "title": "ACME Sandbox",
  • "state": "active",
  • "type": "development",
  • "region": "VA7",
  • "isDefault": true,
  • "etag": 1,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "",
  • "modifiedBy": "",
  • "_system": {
    }
}

User operations

Sandbox operations available to all users.

List active sandboxes

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the authentication tutorial.

x-user-token
string

The access token for the current user. If present, this token is instead of the token in the Authorization header to lookup sandboxes.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal server error

get/
Response samples
application/json
{
  • "sandboxes": [
    ],
  • "_page": {
    },
  • "_links": {
    }
}