Programs

Get Program

Returns a program by its id

get/api/program/{programId}

Request

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

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

Response

Successful retrieval of program

idstring

Identifier of the program. Unique within the space.

namestring required

Name of the program

enabledboolean

Whether this Program has been enabled for Cloud Manager usage

tenantIdstring

Tenant Id

imsOrgIdstring

Organisation Id

status'creating' | 'ready' | 'deleting' | 'deleted' | 'deleted_failed' | 'failed'

Status of the program

type'aem_managed_services' | 'aem_cloud_service' | 'media_library' required

The type of program

createdAtstring date-time

Created time

updatedAtstring date-time

Date of last change

Example response

{
  "id": "14",
  "name": "AcmeCorp Main Site",
  "tenantId": "acmeCorp",
  "imsOrgId": "6522A55453334E247F120101@AdobeOrg",
  "type": "aem_cloud_service",
  "capabilities": {
    "sandbox": true
  }
}

Changes

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