Environments

List Environments

Lists all environments in an program

get/api/program/{programId}/environments

Request

  • Base URL: https://cloudmanager.adobe.io
  • URL: https://cloudmanager.adobe.io/api/program/{programId}/environments
  • Auth: none declared. Required headers: x-gw-ims-org-id, Authorization, x-api-key

Path parameters

programIdstring required

Identifier of the program

Query parameters

type'dev' | 'stage' | 'prod' | 'rde' | 'preprod'

Type of the environment

Headers

x-gw-ims-org-idstring required

IMS organization ID that the request is being made under.

Authorizationstring required

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-keystring required

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Response

Successful retrieval of environment list

_totalNumberOfItemsinteger

The total number of embedded items

Example response

{
  "_embedded": {
    "environments": [
      {
        "programId": "14",
        "name": "AcmeCorp Dev1 Environment",
        "description": "This is our primary development environment",
        "type": "dev",
        "status": "creating",
        "region": "va7"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.