Environments

Create or clone Environment

Create Environment

post/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, Content-Type

Path parameters

programIdstring required

Identifier of the program

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

Content-Typestring required

Must always be application/json

Request body

namestring required

Name of the environment

type'dev' | 'stage' | 'prod' | 'rde' required
regionstring required

Region to create the environment.

descriptionstring

Description of the environment

Example request

{
  "name": "acme-dev1",
  "region": "va7",
  "description": "This is our primary development environment"
}

Response

Environment created

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.