Edit in GitHubLog an issue

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:

Copied to your clipboard
1PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1
2
3{
4 "phases" : [
5 {
6 "name":"BUILD_1",
7 "type":"BUILD",
8 "repositoryId" : "1",
9 "branch": "develop"
10 }
11 ]
12}

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:

Copied to your clipboard
1PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1
2
3{
4 "phases" : [
5 {
6 "name":"BUILD_1",
7 "type":"BUILD",
8 "repositoryId" : "1",
9 "branch": "refs/tags/release-20200214"
10 }
11 ]
12}

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:

Copied to your clipboard
1PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1
2
3{
4 "phases" : [
5 {
6 "name":"DEPLOY_1",
7 "type":"DEPLOY",
8 "environmentId" : "15"
9 }
10 ]
11}

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:

Copied to your clipboard
1PATCH https://cloudmanager.adobe.io/api/program/4/pipeline/1
2
3{
4 "phases" : [
5 {
6 "name":"DEPLOY_1",
7 "type":"DEPLOY",
8 "steps": [
9 "name": "deploy",
10 "options": {
11 "dispatcherCacheInvalidationPaths": [
12 "/content/mysite/home.html"
13 ],
14 "dispatcherCacheFlushPaths": [
15 "/etc.clientlibs"
16 ]
17 }
18 ]
19 }
20 ]
21}

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.

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.

Copied to your clipboard
DELETE https://cloudmanager.adobe.io/api/program/4/pipeline/1
  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.