Creating Programs and Environments

Creating AEM Cloud Service Programs#

Based on the entitlements available for an organization, AEM Cloud Service programs may be created through the Cloud Manager API. This is done by executing a POST request to the http://ns.adobe.com/adobecloud/rel/programs HAL link of the tenant resource. To discover the tenant resource, you can either navigate to the http://ns.adobe.com/adobecloud/rel/tenant HAL link from any existing program or execute a GET request to https://cloudmanager.adobe.io/api/tenants. This response will contain exactly one tenant resource.

Creating a Production Program#

To create a production program, the body of the POST request needs to include the type aem_cloud_service, a name, and at least one solution name. The allowed solutions are aemsites and aemassets.

For example:

POST https://cloudmanager.adobe.io/api/tenant/1/programs

{
  "name": "My Second Program",
  "type": "aem_cloud_service",
  "solutionNames": ["aemsites"]
}
CopyCopied to your clipboard
1POST https://cloudmanager.adobe.io/api/tenant/1/programs
2
3{
4  "name": "My Second Program",
5  "type": "aem_cloud_service",
6  "solutionNames": ["aemsites"]
7}

Creating a Sandbox Program#

To create a sandbox program, the body of the POST request needs to include the type aem_cloud_service, a name, and a capabilities object that specifies that it is a sandbox program.

For example:

POST https://cloudmanager.adobe.io/api/tenant/1/programs

{
  "name": "My Second Program",
  "type": "aem_cloud_service",
  "capabilities": {
    "sandbox": true
  }
}
CopyCopied to your clipboard
1POST https://cloudmanager.adobe.io/api/tenant/1/programs
2
3{
4  "name": "My Second Program",
5  "type": "aem_cloud_service",
6  "capabilities": {
7    "sandbox": true
8  }
9}

Creating AEM Cloud Service Environments#

In order to find the set of currently available regions, execute a GET request to the http://ns.adobe.com/adobecloud/rel/regions HAL link of the program.

GET https://cloudmanager.adobe.io/api/program/4/regions
CopyCopied to your clipboard
GET https://cloudmanager.adobe.io/api/program/4/regions

This will return a list like this:

{
  "_embedded": {
    "regions": [
      {
        "name": "va7"
      },
      {
        "name": "nld2"
      }
    ]
  },
  "_totalNumberOfItems": 2
}
CopyCopied to your clipboard
1{
2  "_embedded": {
3    "regions": [
4      {
5        "name": "va7"
6      },
7      {
8        "name": "nld2"
9      }
10    ]
11  },
12  "_totalNumberOfItems": 2
13}

The set of available regions will vary based on capacity and entitlements, so always check this list before creating an environment. The superset of possible regions are:

• aus5 - Australia Southeast
• can2 - Canada
• deu6 - Germany
• gbr9 - UK South
• jpn4 - Japan
• nld2 - West Europe
• sgp5 - Singapore
• va7 - East US
• wa1 - West US

Using this value, you can then execute a POST request to the http://ns.adobe.com/adobecloud/rel/environments HAL link of the program with the desired name and type.

POST https://cloudmanager.adobe.io/api/program/4/environments

{
  "name" : "my-second-dev-environment",
  "type" : "dev",
  "region" : "va7"
}
CopyCopied to your clipboard
1POST https://cloudmanager.adobe.io/api/program/4/environments
2
3{
4  "name" : "my-second-dev-environment",
5  "type" : "dev",
6  "region" : "va7"
7}

Important Limitations#

Usage of this API will be limited by the existing environment limits. Specifically:

• Sandbox programs are limited to one environment of each type.
• Production programs are limited to one stage and one production environment.
• The total number of dev environments in production programs is limited to the number of dev environments contracted for that organization.

Last updated 11/1/2021

Was this helpful?

Yes

No