Pipeline Execution

Start the pipeline

Starts the Pipeline. This works only if the pipeline is not already started.

put/api/program/{programId}/pipeline/{pipelineId}/execution

Request

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

Path parameters

programIdstring required

Identifier of the program.

pipelineIdstring required

Identifier of the pipeline

Query parameters

pipelineExecutionMode'NORMAL' | 'EMERGENCY'

The mode in which to run the execution. EMERGENCY mode will skip certain steps and is only available to select AMS customers.

stepIdstring

Identifier of the step from which the re-execution will start

sourceExecutionIdstring

Identifier of the source execution from which the execution will start

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

Response

Successfully started pipeline execution

idstring

Pipeline execution identifier

programIdstring

Identifier of the program. Unique within the space.

pipelineIdstring

Identifier of the pipeline. Unique within the space.

artifactsVersionstring

Version of the artifacts generated during this execution

userstring

AdobeID who started the pipeline. Empty for auto triggered builds

status'NOT_STARTED' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'FINISHED' | 'ERROR' | 'FAILED'

Status of the execution

trigger'ON_COMMIT' | 'MANUAL' | 'PUSH_UPGRADES'

How the execution was triggered.

pipelineExecutionMode'NORMAL' | 'EMERGENCY'

The mode in which the execution occurred. EMERGENCY mode will skip certain steps and is only available to select AMS customers

createdAtstring date-time

Timestamp at which the execution was created

updatedAtstring date-time

Timestamp at which the status of the execution last changed

finishedAtstring date-time

Timestamp at which the execution completed

pipelineType'CI_CD' | 'CODE_GENERATOR'

Pipeline type

Example response

{
  "programId": "14",
  "pipelineId": "10",
  "user": "0123456789ABCDE@AdobeID",
  "pipelineType": "CI_CD",
  "_embedded": {
    "stepStates": [
      {
        "action": "build",
        "status": "NOT_STARTED"
      }
    ]
  }
}

Changes

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