API Model Definitions

Programs

`createdAt`	`string`Created time
`id`	`integer`Identifier of the feedback. Unique within the space.
`rating`	`integer`Rating values from 1 to 5
`comment`	`string`Feedback comment
`type`	`string`Type of feedbackEnum: `GO_LIVE`
`options`	`object` Optional information about the feedback

name

stringNew program name

type

stringEnum: aem_cloud_service

capabilities

sandbox

booleanIndicator of a sandbox program.

solutionNames

Array of stringList of solutions to be enabled on the new program.Enum: aemsites, aemassets

goLive

`plannedDate`	`string`Date when go live is planned
`actualDate`	`string`Date when the program completed go live

`id`	`string`Identifier of the New Relic sub account User
`firstName`	`string`First name of the New Relic sub account User
`lastName`	`string`Last name of the New Relic sub account User
`email`	`string`email of the New Relic sub account user
`role`	`string`Role of the New Relic sub account user
`owner`	`boolean`Owner detail of the New Relic sub account User

_totalNumberOfNewRelicSubAccountUsers

integer <int32>

applicationId

stringThe id of the Cloud Manager application this sub account user list is linked to

_embedded

newRelicUsers

`id`	`string`Identifier of the New Relic sub account User
`firstName`	`string`First name of the New Relic sub account User
`lastName`	`string`Last name of the New Relic sub account User
`email`	`string`email of the New Relic sub account user
`role`	`string`Role of the New Relic sub account user
`owner`	`boolean`Owner detail of the New Relic sub account User

_links

http://ns.adobe.com/adobecloud/rel/application

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/newRelicSubAccount

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

id

stringIdentifier of the program. Unique within the space.

name

stringName of the program

enabled

booleanWhether this Program has been enabled for Cloud Manager usage

tenantId

stringTenant Id

imsOrgId

stringOrganisation Id

status

stringStatus of the programEnum: creating, ready, deleting, deleted, deleted_failed, failed

type

stringThe type of programEnum: aem_managed_services, aem_cloud_service, media_library

capabilities

sandbox

booleanIndicator of a sandbox program.

createdAt

string <date-time>Created time

updatedAt

string <date-time>Date of last change

_links

http://ns.adobe.com/adobecloud/rel/pipelines

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/environments

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/repositories

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/ipAllowlists

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/certificates

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/tenant

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/networkInfrastructures

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/regions

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_page

`start`	`integer` <int32>The start index for the current page of results
`limit`	`integer` <int32>The item limit for the current page of results
`next`	`integer` <int32>The start index for the next page of results
`prev`	`integer` <int32>The start index for the previous page of results
`orderBy`	`string`
`property`	Array of `string`
`type`	`string`

_embedded

programs

id

stringIdentifier of the program. Unique within the space.

name

stringName of the program

enabled

booleanWhether this Program has been enabled for Cloud Manager usage

tenantId

stringTenant Id

status

stringStatus of the programEnum: creating, ready, deleting, deleted, deleted_failed, failed

createdAt

string <date-time>Created time

updatedAt

string <date-time>Date of last change

_links

http://ns.adobe.com/adobecloud/rel/tenant

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

page

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Repositories

repo

stringRepository name. Once set it cannot be updated

description

stringdescription

repositoryUrl

stringRepository Url.

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/branches

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_page

`start`	`integer` <int32>The start index for the current page of results
`limit`	`integer` <int32>The item limit for the current page of results
`next`	`integer` <int32>The start index for the next page of results
`prev`	`integer` <int32>The start index for the previous page of results
`orderBy`	`string`
`property`	Array of `string`
`type`	`string`

_embedded

repositories

repo

stringRepository name. Once set it cannot be updated

description

stringdescription

repositoryUrl

stringRepository Url.

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/branches

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

page

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Branches

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

branches

programId

stringIdentifier of the program. Unique within the space

repositoryId

integer <int64>Identifier of the repository

name

stringName of the branch

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/repository

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Pipelines

id

stringIdentifier of the pipeline. Unique within the program.

programId

stringIdentifier of the program. Unique within the space.

name

stringName of the pipeline

trigger

stringHow should the execution be triggered. ON_COMMIT: each time one or more commits are pushed and the Pipeline is idle then a execution is triggered. MANUAL: triggerd through UI or API.Enum: ON_COMMIT, MANUAL

status

stringPipeline statusEnum: IDLE, BUSY, WAITING

createdAt

string <date-time>Create date

updatedAt

string <date-time>Update date

lastStartedAt

string <date-time>Last pipeline execution start

lastFinishedAt

string <date-time>Last pipeline execution end

phases

name

stringName of the phase

type

stringType of the phaseEnum: VALIDATE, BUILD, DEPLOY

repositoryId

stringIdentifier of the source repository. The code from this repository will be build at the start of this phase. Mandatory if type=BUILD

branch

stringName of the tracked branch or a fully qualified git tag (e.g. refs/tags/v1). Assumed to be `master` if missing.

environmentId

stringIdentifier of the target environment. Mandatory if type=DEPLOY

environmentType

stringType of environment (for example stage or prod, readOnly = true)Enum: dev, stage, prod, rde, preprod

steps

name

stringName of the step

options

`skipDetachingDispatchers`	`boolean`For deploy steps on AMS pipelines, if true will not detach dispatcher from the load balancer.
`dispatcherCacheInvalidationPaths`	Array of `string`For deploy steps on AMS pipelines, list of paths to invalidate on dispatchers after package installation.
`dispatcherCacheFlushPaths`	Array of `string`For deploy steps on AMS pipelines, list of paths to flush on dispatchers after package installation.
`cse`	`string`For managed steps on AMS pipelines, which CSE will be responsible for CSE oversight.Enum: `MY_CSE`, `ANY_CSE`
`popularPagesWeight`	`integer` <int32>For loadTest steps on AMS pipelines, the percentage of performance test traffic which will be sent to the popular pages bucket.
`newPagesWeight`	`integer` <int32>For loadTest steps on AMS pipelines, the percentage of performance test traffic which will be sent to the new pages bucket.
`otherPagesWeight`	`integer` <int32>For loadTest steps on AMS pipelines, the percentage of performance test traffic which will be sent to the other pages bucket.
`imageAssetsWeight`	`integer` <int32>For assetsTest steps on AMS pipelines, the percentage of asset uploads which will be test images.
`pdfAssetsWeight`	`integer` <int32>For assetsTest steps on AMS pipelines, the percentage of asset uploads which will be test PDF files.

type

stringPipeline typeEnum: CI_CD, CODE_GENERATOR

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/execution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/execution/id

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/executions

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/variables

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/rollbackLastSuccessfulExecution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/cache

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_page

`start`	`integer` <int32>The start index for the current page of results
`limit`	`integer` <int32>The item limit for the current page of results
`next`	`integer` <int32>The start index for the next page of results
`prev`	`integer` <int32>The start index for the previous page of results
`orderBy`	`string`
`property`	Array of `string`
`type`	`string`

_embedded

pipelines

id

stringIdentifier of the pipeline. Unique within the program.

programId

stringIdentifier of the program. Unique within the space.

name

stringName of the pipeline

trigger

status

stringPipeline statusEnum: IDLE, BUSY, WAITING

createdAt

string <date-time>Create date

updatedAt

string <date-time>Update date

lastStartedAt

string <date-time>Last pipeline execution start

lastFinishedAt

string <date-time>Last pipeline execution end

phases

name

stringName of the phase

type

stringType of the phaseEnum: VALIDATE, BUILD, DEPLOY

repositoryId

stringIdentifier of the source repository. The code from this repository will be build at the start of this phase. Mandatory if type=BUILD

branch

stringName of the tracked branch or a fully qualified git tag (e.g. refs/tags/v1). Assumed to be `master` if missing.

environmentId

stringIdentifier of the target environment. Mandatory if type=DEPLOY

environmentType

stringType of environment (for example stage or prod, readOnly = true)Enum: dev, stage, prod, rde, preprod

steps

name

stringName of the step

options

`skipDetachingDispatchers`	`boolean`For deploy steps on AMS pipelines, if true will not detach dispatcher from the load balancer.
`dispatcherCacheInvalidationPaths`	Array of `string`For deploy steps on AMS pipelines, list of paths to invalidate on dispatchers after package installation.
`dispatcherCacheFlushPaths`	Array of `string`For deploy steps on AMS pipelines, list of paths to flush on dispatchers after package installation.
`cse`	`string`For managed steps on AMS pipelines, which CSE will be responsible for CSE oversight.Enum: `MY_CSE`, `ANY_CSE`
`popularPagesWeight`	`integer` <int32>For loadTest steps on AMS pipelines, the percentage of performance test traffic which will be sent to the popular pages bucket.
`newPagesWeight`	`integer` <int32>For loadTest steps on AMS pipelines, the percentage of performance test traffic which will be sent to the new pages bucket.
`otherPagesWeight`	`integer` <int32>For loadTest steps on AMS pipelines, the percentage of performance test traffic which will be sent to the other pages bucket.
`imageAssetsWeight`	`integer` <int32>For assetsTest steps on AMS pipelines, the percentage of asset uploads which will be test images.
`pdfAssetsWeight`	`integer` <int32>For assetsTest steps on AMS pipelines, the percentage of asset uploads which will be test PDF files.

type

stringPipeline typeEnum: CI_CD, CODE_GENERATOR

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/execution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/execution/id

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/executions

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/variables

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/rollbackLastSuccessfulExecution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/cache

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

page

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

phases

name

stringName of the phase

type

stringType of the phaseEnum: BUILD, DEPLOY

repositoryId

stringFor BUILD phase type. Identifier of the source repository. The code from this repository will be build at the start of this phase. If not provided, the current value is retained.

branch

stringFor BUILD phase type. Name of the tracked branch or a fully qualified git tag (e.g. refs/tags/v1). If not provided, the current value is retained.

environmentId

stringFor DEPLOY phase type. Identifier of the target environment.

steps

name

stringName of the step

options

`dispatcherCacheInvalidationPaths`	Array of `string`For deploy steps on AMS pipelines, list of paths to invalidate on dispatchers after package installation.
`dispatcherCacheFlushPaths`	Array of `string`For deploy steps on AMS pipelines, list of paths to flush on dispatchers after package installation.

Pipeline Execution

id

stringPipeline execution identifier

programId

stringIdentifier of the program. Unique within the space.

pipelineId

stringIdentifier of the pipeline. Unique within the space.

artifactsVersion

stringVersion of the artifacts generated during this execution

user

stringAdobeID who started the pipeline. Empty for auto triggered builds

status

stringStatus of the executionEnum: NOT_STARTED, RUNNING, CANCELLING, CANCELLED, FINISHED, ERROR, FAILED

trigger

stringHow the execution was triggered.Enum: ON_COMMIT, MANUAL, PUSH_UPGRADES

pipelineExecutionMode

stringThe mode in which the execution occurred. EMERGENCY mode will skip certain steps and is only available to select AMS customersEnum: NORMAL, EMERGENCY

createdAt

string <date-time>Timestamp at which the execution was created

updatedAt

string <date-time>Timestamp at which the status of the execution last changed

finishedAt

string <date-time>Timestamp at which the execution completed

pipelineType

stringPipeline typeEnum: CI_CD, CODE_GENERATOR

_embedded

stepStates

id

string

stepId

string

phaseId

string

action

stringName of the action

repository

stringTarget repository

branch

stringTarget branch

environment

stringTarget environment

environmentId

stringTarget environment id

environmentType

stringTarget environment type

startedAt

string <date-time>Timestamp at which the step state started running

finishedAt

string <date-time>Timestamp at which the step completed

commitId

stringTarget commit id

details

`deployCommands`	`string`For deploy steps, a JSON array encoded as a string which lists the deployment activities expected to be performed.
`currentDeployCommandId`	`string`For deploy steps, the current identifier from the deployCommands which is being executed.
`environmentUrls`	Array of `object`For deploy steps, the the set of URLs for the environment.
`deploymentStepDescription`	`string`For deploy steps, a JSON array encoded as a string which includes the detailed list of deployment activities which have been performed.
`input`	`object` Input provided when advancing the step. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.

status

stringAction statusEnum: NOT_STARTED, RUNNING, FINISHED, ERROR, ROLLING_BACK, ROLLED_BACK, WAITING, CANCELLED, FAILED, INCOMPLETE

_links

http://ns.adobe.com/adobecloud/rel/execution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/logs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/metrics

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/reExecute

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/advance

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/cancel

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_page

`start`	`integer` <int32>The start index for the current page of results
`limit`	`integer` <int32>The item limit for the current page of results
`next`	`integer` <int32>The start index for the next page of results
`prev`	`integer` <int32>The start index for the previous page of results
`orderBy`	`string`
`property`	Array of `string`
`type`	`string`

_embedded

executions

id

stringPipeline execution identifier

programId

stringIdentifier of the program. Unique within the space.

pipelineId

stringIdentifier of the pipeline. Unique within the space.

artifactsVersion

stringVersion of the artifacts generated during this execution

user

stringAdobeID who started the pipeline. Empty for auto triggered builds

status

stringStatus of the executionEnum: NOT_STARTED, RUNNING, CANCELLING, CANCELLED, FINISHED, ERROR, FAILED

trigger

stringHow the execution was triggered.Enum: ON_COMMIT, MANUAL, PUSH_UPGRADES

pipelineExecutionMode

stringThe mode in which the execution occurred. EMERGENCY mode will skip certain steps and is only available to select AMS customersEnum: NORMAL, EMERGENCY

createdAt

string <date-time>Timestamp at which the execution was created

updatedAt

string <date-time>Timestamp at which the status of the execution last changed

finishedAt

string <date-time>Timestamp at which the execution completed

pipelineType

stringPipeline typeEnum: CI_CD, CODE_GENERATOR

_embedded

stepStates

id

string

stepId

string

phaseId

string

action

stringName of the action

repository

stringTarget repository

branch

stringTarget branch

environment

stringTarget environment

environmentId

stringTarget environment id

environmentType

stringTarget environment type

startedAt

string <date-time>Timestamp at which the step state started running

finishedAt

string <date-time>Timestamp at which the step completed

commitId

stringTarget commit id

details

`deployCommands`	`string`For deploy steps, a JSON array encoded as a string which lists the deployment activities expected to be performed.
`currentDeployCommandId`	`string`For deploy steps, the current identifier from the deployCommands which is being executed.
`environmentUrls`	Array of `object`For deploy steps, the the set of URLs for the environment.
`deploymentStepDescription`	`string`For deploy steps, a JSON array encoded as a string which includes the detailed list of deployment activities which have been performed.
`input`	`object` Input provided when advancing the step. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.

status

stringAction statusEnum: NOT_STARTED, RUNNING, FINISHED, ERROR, ROLLING_BACK, ROLLED_BACK, WAITING, CANCELLED, FAILED, INCOMPLETE

_links

http://ns.adobe.com/adobecloud/rel/execution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/logs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/metrics

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/reExecute

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/advance

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/cancel

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

page

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

id

string

stepId

string

phaseId

string

action

stringName of the action

repository

stringTarget repository

branch

stringTarget branch

environment

stringTarget environment

environmentId

stringTarget environment id

environmentType

stringTarget environment type

startedAt

string <date-time>Timestamp at which the step state started running

finishedAt

string <date-time>Timestamp at which the step completed

commitId

stringTarget commit id

details

`deployCommands`	`string`For deploy steps, a JSON array encoded as a string which lists the deployment activities expected to be performed.
`currentDeployCommandId`	`string`For deploy steps, the current identifier from the deployCommands which is being executed.
`environmentUrls`	Array of `object`For deploy steps, the the set of URLs for the environment.
`deploymentStepDescription`	`string`For deploy steps, a JSON array encoded as a string which includes the detailed list of deployment activities which have been performed.
`input`	`object` Input provided when advancing the step. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.

status

stringAction statusEnum: NOT_STARTED, RUNNING, FINISHED, ERROR, ROLLING_BACK, ROLLED_BACK, WAITING, CANCELLED, FAILED, INCOMPLETE

_links

http://ns.adobe.com/adobecloud/rel/execution

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/logs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/metrics

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/reExecute

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/advance

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline/cancel

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

metrics

`id`	`string`KPI result identifier
`severity`	`string`Severity of the metricEnum: `critical`, `important`, `informational`
`passed`	`boolean`Whether metric is considered passed
`override`	`boolean`Whether user override the failed metric
`actualValue`	`string`Expected value for the metric
`expectedValue`	`string`Expected value for the metric
`comparator`	`string`Comparator used for the metricEnum: `GT`, `GTE`, `LT`, `LTE`, `EQ`, `NEQ`
`kpi`	`string`KPI identifier

object

Environments

id

stringid

programId

stringIdentifier of the program. Unique within the space.

name

stringName of the environment

description

stringDescription of the environment

type

stringType of the environmentEnum: dev, stage, prod, rde, preprod

status

stringStatus of the environmentEnum: creating, ready, deleting, deleted, updating, failed, deploy_failed, created, restoring, restore_failed, resetting, reset_failed, degraded, hibernated

region

stringRegion of the environment

availableLogOptions

`service`	`string`Name of the service in environment. Example: author
`name`	`string`Name of the log for service in environment. Example: aemerror

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/author

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/publish

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/preview

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/developerConsole

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/logs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/variables

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/advancedNetworking

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

environments

id

stringid

programId

stringIdentifier of the program. Unique within the space.

name

stringName of the environment

description

stringDescription of the environment

type

stringType of the environmentEnum: dev, stage, prod, rde, preprod

status

region

stringRegion of the environment

availableLogOptions

`service`	`string`Name of the service in environment. Example: author
`name`	`string`Name of the log for service in environment. Example: aemerror

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/author

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/publish

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/preview

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/developerConsole

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/logs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/variables

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/advancedNetworking

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

service

Array of stringName of the service

name

Array of stringName of the Log

days

integer <int32>Number of days

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_embedded

downloads

service

stringName of the service

name

stringName of the Log

date

string <date>date of the Log

programId

integer <int64>

environmentId

integer <int64>

_links

http://ns.adobe.com/adobecloud/rel/logs/download

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/logs/tail

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

`name`	`string`Name of the environment
`type`	`string`Enum: `dev`, `stage`, `prod`, `rde`
`region`	`string`Region to create the environment.
`description`	`string`Description of the environment

Region Deployment

region

stringRegion to be added in the environment

cluster

stringThe cluster where this deployment happens

namespace

stringThe namespace in which this deployment happens

createdAt

string <date-time>Created time

updatedAt

string <date-time>Date of last change

id

stringidentifier of a region deployment

environmentId

stringidentifier of an environment

region

stringRegion name of the deployment

integrations

blobStorage

type

stringEnum: azure_blob, azure_files, mongo_atlas

logStorage

type

stringEnum: azure_blob, azure_files, mongo_atlas

status

stringStatus of the region deploymentEnum: PENDING, PROGRESSING, FAILED, COMPLETE, DELETING, DELETED, DELETION_FAILED, TO_DELETE, DEPLOY_FAILED, DEPLOY_TIMEOUT

type

stringType of the region deploymentEnum: PRIMARY, SECONDARY

_links

http://ns.adobe.com/adobecloud/rel/flow

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/kubernetesCluster

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/kubernetesNamespace

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/region

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

`id`	`string`Identifier of the region deployment
`status`	`string`Status of the region deployment to be set

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

regionDeployments

cluster

stringThe cluster where this deployment happens

namespace

stringThe namespace in which this deployment happens

createdAt

string <date-time>Created time

updatedAt

string <date-time>Date of last change

id

stringidentifier of a region deployment

environmentId

stringidentifier of an environment

region

stringRegion name of the deployment

integrations

blobStorage

type

stringEnum: azure_blob, azure_files, mongo_atlas

logStorage

type

stringEnum: azure_blob, azure_files, mongo_atlas

status

stringStatus of the region deploymentEnum: PENDING, PROGRESSING, FAILED, COMPLETE, DELETING, DELETED, DELETION_FAILED, TO_DELETE, DEPLOY_FAILED, DEPLOY_TIMEOUT

type

stringType of the region deploymentEnum: PRIMARY, SECONDARY

_links

http://ns.adobe.com/adobecloud/rel/flow

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/kubernetesCluster

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/kubernetesNamespace

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/region

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Variables

`name`	`string`Name of the variable. Can only consist of a-z, A-Z, _ and 0-9 and cannot begin with a number.
`value`	`string`Value of the variable. Read-Write for non-secrets, write-only for secrets. The length of `secretString` values must be less than 500 characters. An empty value causes a variable to be deleted.
`type`	`string`Type of the variable. Default `string` if missing. `secretString` variables are encrypted at rest. The type of a variable be changed after creation; the variable must be deleted and recreated.Enum: `string`, `secretString`
`service`	`string`Service of the variable. When not provided, the variable applies to all services. Currently the values 'author', 'publish', and 'preview' are supported. Note - this value is case-sensitive.

`name`	`string`Name of the variable. Can only consist of a-z, A-Z, _ and 0-9 and cannot begin with a number.
`value`	`string`Value of the variable. Read-Write for non-secrets, write-only for secrets. The length of `secretString` values must be less than 500 characters. An empty value causes a variable to be deleted.
`type`	`string`Type of the variable. Default `string` if missing. `secretString` variables are encrypted at rest. The type of a variable be changed after creation; the variable must be deleted and recreated.Enum: `string`, `secretString`

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

variables

`name`	`string`Name of the variable. Can only consist of a-z, A-Z, _ and 0-9 and cannot begin with a number.
`value`	`string`Value of the variable. Read-Write for non-secrets, write-only for secrets. The length of `secretString` values must be less than 500 characters. An empty value causes a variable to be deleted.
`type`	`string`Type of the variable. Default `string` if missing. `secretString` variables are encrypted at rest. The type of a variable be changed after creation; the variable must be deleted and recreated.Enum: `string`, `secretString`
`service`	`string`Service of the variable. When not provided, the variable applies to all services. Currently the values 'author', 'publish', and 'preview' are supported. Note - this value is case-sensitive.
`status`	`string`Status of the variableEnum: `creating`, `ready`, `deleting`, `deleted`, `updating`, `failed`, `deleted_failed`

_links

http://ns.adobe.com/adobecloud/rel/environment

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/pipeline

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

IP Allowlist

`name`	`string`Name of the IP Allowed List
`ipCidrSet`	Array of `string`IP CIDR Set

id

integer <int64>Identifier of the IP Allowed List

name

stringName of the IP Allowed List

programId

integer <int64>Identifier of the program.

ipCidrSet

Array of stringIP CIDR Set

bindings

id

integer <int64>Identifier of the IP Allowed List Binding to an Environment

tier

stringTier of the environment.Enum: PUBLISH, PREVIEW

status

stringStatus of the binding.

programId

integer <int64>Identifier of the program.

ipAllowListId

integer <int64>Identifier of the IP allow list.

environmentId

integer <int64>Identifier of the environment.

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/ipAllowList

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

http://ns.adobe.com/adobecloud/rel/ipAllowlistBindings

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

ipAllowlists

id

integer <int64>Identifier of the IP Allowed List

name

stringName of the IP Allowed List

programId

integer <int64>Identifier of the program.

ipCidrSet

Array of stringIP CIDR Set

bindings

id

integer <int64>Identifier of the IP Allowed List Binding to an Environment

tier

stringTier of the environment.Enum: PUBLISH, PREVIEW

status

stringStatus of the binding.

programId

integer <int64>Identifier of the program.

ipAllowListId

integer <int64>Identifier of the IP allow list.

environmentId

integer <int64>Identifier of the environment.

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/ipAllowList

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

http://ns.adobe.com/adobecloud/rel/ipAllowlistBindings

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

`name`	`string`Name of the IP Allowed List
`ipCidrSet`	Array of `string`IP CIDR Set

IP Allowlist Binding

id

integer <int64>Identifier of the IP Allowed List Binding to an Environment

tier

stringTier of the environment.Enum: PUBLISH, PREVIEW

status

stringStatus of the binding.

programId

integer <int64>Identifier of the program.

ipAllowListId

integer <int64>Identifier of the IP allow list.

environmentId

integer <int64>Identifier of the environment.

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/ipAllowList

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

ipAllowlistId

string

_embedded

ipAllowlistBindings

id

integer <int64>Identifier of the IP Allowed List Binding to an Environment

tier

stringTier of the environment.Enum: PUBLISH, PREVIEW

status

stringStatus of the binding.

programId

integer <int64>Identifier of the program.

ipAllowListId

integer <int64>Identifier of the IP allow list.

environmentId

integer <int64>Identifier of the environment.

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

http://ns.adobe.com/adobecloud/rel/ipAllowList

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Domain Names

SSL Certificates

Tenants

id

stringIdentifier of the tenant

imsOrgId

stringIMS Organization of this tenant

imsTenantId

stringIMS Tenant Id

description

stringDescription of the tenant

status

stringStatus of the tenantEnum: creating, ready, failed

organisation

`organizationName`	`string`Name of the git repository organization
`status`	`string`Status of the organisation on-boarding processEnum: `not_started`, `creating`, `ready`, `failed`

_links

http://ns.adobe.com/adobecloud/rel/programs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

tenants

id

stringIdentifier of the tenant

imsOrgId

stringIMS Organization of this tenant

imsTenantId

stringIMS Tenant Id

description

stringDescription of the tenant

status

stringStatus of the tenantEnum: creating, ready, failed

organisation

`organizationName`	`string`Name of the git repository organization
`status`	`string`Status of the organisation on-boarding processEnum: `not_started`, `creating`, `ready`, `failed`

_links

http://ns.adobe.com/adobecloud/rel/programs

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Regions

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

regions

name

stringRegion name

_links

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Network Infrastructure

kind

stringKind of the infrastructureEnum: vpn, dedicatedEgressIp, flexiblePortEgress

id

stringid

programId

stringIdentifier of the program. Unique within the space.

status

stringStatus of the network configurationEnum: creating, failed, updating, deleting, deleted, ready, error

region

stringRegion to create the infrastructure. Use your primary region, whose identifier can be retrieved from the [List Regions endpoint](#operation/getProgramRegions).

isPrimaryRegion

booleanBoolean property to mark whether network infrastructure being created is for primary region or not.

created

string <date-time>Creation date

updated

string <date-time>Last modification date

addressSpace

Array of stringA list of CIDRs. It can only be one /26 CIDR (64 IP addresses) or bigger IP range in the customer space. Cannot be changed later. Only applicable to VPN.

dns

resolvers

Array of stringList of remote DNS resolvers

connections

name

stringName of the connection

gateway

`address`	`string`Customer VPN Device IP Address
`addressSpace`	Array of `string`IP Ranges to route through the VPN

sharedKey

stringCustomer VPN preshared key

ipsecPolicy

`dhGroup`	`string`DH GroupEnum: `DHGroup24`, `ECP384`, `ECP256`, `DHGroup14`, `DHGroup2048`, `DHGroup2`, `DHGroup1`, `None`
`ikeEncryption`	`string`IKEv2 EncryptionEnum: `AES256`, `AES192`, `AES128`, `DES3`, `DES`
`ikeIntegrity`	`string`IKEv2 IntegrityEnum: `SHA384`, `SHA256`, `SHA1`, `MD5`
`ipsecEncryption`	`string`IPsec EncryptionEnum: `GCMAES256`, `GCMAES192`, `GCMAES128`, `AES256`, `AES192`, `AES128`, `DES3`, `DES`, `None`
`ipsecIntegrity`	`string`IPsec IntegrityEnum: `GCMAES256`, `GCMAES192`, `GCMAES128`, `SHA256`, `SHA1`, `MD5`
`pfsGroup`	`string`PFS GroupEnum: `PFS24`, `ECP384`, `ECP256`, `PFS2048`, `PFS2`, `PFS1`, `None`
`saDatasize`	`integer` <int64>QM SA Lifetime in KBytes under 1024
`saLifetime`	`integer` <int32>QM SA Lifetime in Seconds, minimum 300

statusDetails

`errorCode`	`string`The error code
`publicDetails`	`object` Additional error details that can be used by customer
`message`	`string`Human readable error message

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

networkInfrastructures

kind

stringKind of the infrastructureEnum: vpn, dedicatedEgressIp, flexiblePortEgress

id

stringid

programId

stringIdentifier of the program. Unique within the space.

status

stringStatus of the network configurationEnum: creating, failed, updating, deleting, deleted, ready, error

region

stringRegion to create the infrastructure. Use your primary region, whose identifier can be retrieved from the [List Regions endpoint](#operation/getProgramRegions).

isPrimaryRegion

booleanBoolean property to mark whether network infrastructure being created is for primary region or not.

created

string <date-time>Creation date

updated

string <date-time>Last modification date

addressSpace

Array of stringA list of CIDRs. It can only be one /26 CIDR (64 IP addresses) or bigger IP range in the customer space. Cannot be changed later. Only applicable to VPN.

dns

resolvers

Array of stringList of remote DNS resolvers

connections

name

stringName of the connection

gateway

`address`	`string`Customer VPN Device IP Address
`addressSpace`	Array of `string`IP Ranges to route through the VPN

sharedKey

stringCustomer VPN preshared key

ipsecPolicy

`dhGroup`	`string`DH GroupEnum: `DHGroup24`, `ECP384`, `ECP256`, `DHGroup14`, `DHGroup2048`, `DHGroup2`, `DHGroup1`, `None`
`ikeEncryption`	`string`IKEv2 EncryptionEnum: `AES256`, `AES192`, `AES128`, `DES3`, `DES`
`ikeIntegrity`	`string`IKEv2 IntegrityEnum: `SHA384`, `SHA256`, `SHA1`, `MD5`
`ipsecEncryption`	`string`IPsec EncryptionEnum: `GCMAES256`, `GCMAES192`, `GCMAES128`, `AES256`, `AES192`, `AES128`, `DES3`, `DES`, `None`
`ipsecIntegrity`	`string`IPsec IntegrityEnum: `GCMAES256`, `GCMAES192`, `GCMAES128`, `SHA256`, `SHA1`, `MD5`
`pfsGroup`	`string`PFS GroupEnum: `PFS24`, `ECP384`, `ECP256`, `PFS2048`, `PFS2`, `PFS1`, `None`
`saDatasize`	`integer` <int64>QM SA Lifetime in KBytes under 1024
`saLifetime`	`integer` <int32>QM SA Lifetime in Seconds, minimum 300

statusDetails

`errorCode`	`string`The error code
`publicDetails`	`object` Additional error details that can be used by customer
`message`	`string`Human readable error message

_links

http://ns.adobe.com/adobecloud/rel/program

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

Environment Advanced Networking Configuration

_totalNumberOfItems

integer <int32>The total number of embedded items

_embedded

networkingConfigurations

programId

stringIdentifier of the program. Unique within the space.

environmentId

stringIdentifier of the environment. Unique within the space.

networkInfrastructureId

stringAdvanced network infrastructure used.

nonProxyHosts

Array of stringA list of hosts that should be reached directly, bypassing the special VPN or egress routing. The patterns may start or end with a ''*'' for wildcards.

portForwards

`name`	`string`Destination host
`portDest`	`integer` <int32>Destination port
`portOrig`	`integer` <int32>Origin port for tunnel. Must be unique and in 30000-31000 range.

advancedNetworkingEnabled

booleanWhether advanced networking is enabled in this environment

_links

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

_links

next

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

prev

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

self

`href`	`string`
`templated`	`boolean`
`type`	`string`
`deprecation`	`string`
`profile`	`string`
`title`	`string`
`hreflang`	`string`
`name`	`string`

nonProxyHosts

Array of stringA list of hosts that should be reached directly, bypassing the special VPN or egress routing. The patterns may start or end with a ''*'' for wildcards.

portForwards

`name`	`string`Destination host
`portDest`	`integer` <int32>Destination port
`portOrig`	`integer` <int32>Origin port for tunnel. Must be unique and in 30000-31000 range.

Getting Started

Last updated 10/21/2021

Was this helpful?

Yes

API Model Definitions

Programs

NewFeedback

NewProgram

ProgramCapabilities

GoLiveDates (Go live dates)

NewRelicSubAccountUser

NewRelicSubAccountUserlist

Schema

Array of object <NewRelicSub-AccountUser>

Schema

HalLink

HalLink

HalLink

Program

ProgramCapabilities (Program capabilities)

Schema

HalLink

HalLink

HalLink

HalLink

HalLink

HalLink

HalLink

HalLink

HalLink

ProgramList

RequestedPageDetails (Details of the requested page of items)

Schema

Array of object <EmbeddedProgram>

Schema

HalLink

HalLink

Schema

HalLink

HalLink

HalLink

HalLink

Repositories

Repository

Schema

HalLink

HalLink

HalLink

RepositoryList

RequestedPageDetails (Details of the requested page of items)

Schema

Array of object <Repository>

Schema

HalLink

HalLink

HalLink

Schema

HalLink

HalLink

HalLink

HalLink

Branches

BranchList

Schema

Array of object <RepositoryBranch>

Schema

HalLink

HalLink

Schema

HalLink

HalLink

HalLink

Pipelines

Pipeline

Array of object <PipelinePhase> (Pipeline phases in execution order)

Array of object <PipelineStep> (Steps to be included in the phase in execution order. Might be added or not, depending on permissions or configuration)

PipelineStepOptions (Map of option parameters for the step)

Schema

HalLink

HalLink

HalLink

HalLink

HalLink

HalLink