Editing Pipelines

The Cloud Manager API supports partial editing of pipeline by accepting PATCH requests on the pipeline endpoint. The body of these requests follows the same structure as the response to a GET request to the pipeline endpoint. However, only the changes need to be submitted. Below are a number of examples of the types of changes which are supported using this API.

Editing the Repository or Branch

The body for changing the repository or branch of a pipeline is done by submitting the BUILD phase specifying either the branch or both the branch and repositoryId properties. For example:

Copy
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"BUILD_1",
      "type":"BUILD",
      "repositoryId" : "1",
      "branch": "develop"
    }
  ]
}
Copied to your clipboard
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"BUILD_1",
      "type":"BUILD",
      "repositoryId" : "1",
      "branch": "develop"
    }
  ]
}

Building a Tag

Using this API, it is possible to specify a tag name instead of a branch name. To do this, specify the branch value to refs/tags/TAGNAME. For example, if the tag is release-20200214, you would execute:

Copy
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"BUILD_1",
      "type":"BUILD",
      "repositoryId" : "1",
      "branch": "refs/tags/release-20200214"
    }
  ]
}
Copied to your clipboard
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"BUILD_1",
      "type":"BUILD",
      "repositoryId" : "1",
      "branch": "refs/tags/release-20200214"
    }
  ]
}

Changing the Deployment Environment

Changing the target environment for a pipeline can be done by by submitting the DEPLOY phase which needs to be changed. For example:

Copy
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"DEPLOY_1",
      "type":"DEPLOY",
      "environmentId" : "15"
    }
  ]
}
Copied to your clipboard
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"DEPLOY_1",
      "type":"DEPLOY",
      "environmentId" : "15"
    }
  ]
}

Changing the Dispatcher Invalidation or Flush Paths

Specifically for AMS pipelines, the dispatcher paths which will be invalidated or flushed as part of the deploy process can be specified as part of the DEPLOY phase. For example:

Copy
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"DEPLOY_1",
      "type":"DEPLOY",
      "steps": [
        "name": "deploy",
        "options": {
          "dispatcherCacheInvalidationPaths": [
            "/content/mysite/home.html"
          ],
          "dispatcherCacheFlushPaths": [
            "/etc.clientlibs"
          ]
        }
      ]
    }
  ]
}
Copied to your clipboard
PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1

{
  "phases" : [
    {
      "name":"DEPLOY_1",
      "type":"DEPLOY",
      "steps": [
        "name": "deploy",
        "options": {
          "dispatcherCacheInvalidationPaths": [
            "/content/mysite/home.html"
          ],
          "dispatcherCacheFlushPaths": [
            "/etc.clientlibs"
          ]
        }
      ]
    }
  ]
}

Invalidating a Pipeline's Cache

Deleting a pipeline can be done by executing a DELETE request to the pipeline's cache endpoint, accessible via the http://ns.adobe.com/adobecloud/rel/cache HAL Link of the pipeline endpoint.

Copy
DELETE https://cloudmanager.adobe.io/api/program/4/pipeline/1/cache
Copied to your clipboard
DELETE https://cloudmanager.adobe.io/api/program/4/pipeline/1/cache

Deleting Pipelines

Deleting a pipeline can be done by executing a DELETE request to the pipeline endpoint.

Copy
DELETE https://cloudmanager.adobe.io/api/program/4/pipeline/1
Copied to your clipboard
DELETE https://cloudmanager.adobe.io/api/program/4/pipeline/1

Last updated 11/1/2021

Was this helpful?

Yes

No