Pipelines

Patches Pipeline

Patches a pipeline within an program.

patch/api/program/{programId}/pipeline/{pipelineId}

Request

  • Base URL: https://cloudmanager.adobe.io
  • URL: https://cloudmanager.adobe.io/api/program/{programId}/pipeline/{pipelineId}
  • 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

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

Example request

{
  "phases": [
    {
      "name": "BUILD_1",
      "type": "BUILD",
      "steps": [
        {
          "name": "deploy"
        }
      ]
    }
  ]
}

Response

successful operation

idstring

Identifier of the pipeline. Unique within the program.

programIdstring

Identifier of the program. Unique within the space.

namestring required

Name of the pipeline

trigger'ON_COMMIT' | 'MANUAL'

How 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.

status'IDLE' | 'BUSY' | 'WAITING'

Pipeline status

createdAtstring date-time

Create date

updatedAtstring date-time

Update date

lastStartedAtstring date-time

Last pipeline execution start

lastFinishedAtstring date-time

Last pipeline execution end

type'CI_CD' | 'CODE_GENERATOR'

Pipeline type

Example response

{
  "id": "29",
  "programId": "14",
  "name": "AcmeCorp Main Pipeline",
  "trigger": "MANUAL",
  "status": "IDLE",
  "phases": [
    {
      "name": "DEV Build",
      "type": "DEPLOY",
      "steps": [
        {
          "name": "deploy"
        }
      ]
    }
  ],
  "type": "CI_CD"
}

Changes

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