Environments

Get Environment

Returns an environment by its id

get/api/program/{programId}/environment/{environmentId}

Request

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

Path parameters

programIdstring required

Identifier of the program

environmentIdstring required

Identifier 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 operation

idstring

id

programIdstring

Identifier of the program. Unique within the space.

namestring

Name of the environment

descriptionstring

Description of the environment

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

Type of the environment

status'creating' | 'ready' | 'deleting' | 'deleted' | 'updating' | 'failed' | 'deploy_failed' | 'created' | 'restoring' | 'restore_failed' | 'resetting' | 'reset_failed' | 'degraded' | 'hibernated'

Status of the environment

regionstring

Region of the environment

Example response

{
  "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.