Region Deployments

Get Region Deployment

Return a region deployment by its id

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

Request

  • Base URL: https://cloudmanager.adobe.io
  • URL: https://cloudmanager.adobe.io/api/program/{programId}/environment/{environmentId}/regionDeployments/{regionDeploymentId}
  • 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

regionDeploymentIdstring required

Identifier of the regionDeployment

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 the region deployment for the environment

clusterstring

The cluster where this deployment happens

namespacestring

The namespace in which this deployment happens

createdAtstring date-time

Created time

updatedAtstring date-time

Date of last change

idstring

identifier of a region deployment

environmentIdstring

identifier of an environment

regionstring

Region name of the deployment

status'PENDING' | 'PROGRESSING' | 'FAILED' | 'COMPLETE' | 'DELETING' | 'DELETED' | 'DELETION_FAILED' | 'TO_DELETE' | 'DEPLOY_FAILED' | 'DEPLOY_TIMEOUT'

Status of the region deployment

type'PRIMARY' | 'SECONDARY'

Type of the region deployment

Example response

{
  "cluster": "ethos13stageva7",
  "namespace": "ns-team-aem",
  "region": "va7",
  "type": "primary"
}

Changes

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