Cancel, Retry or Apply

Cancels, retries or approves the execution.

Required scopes: WORKSPACE, EXECUTION_RUN

Resource URL

PATCH /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/executions/:execution_id

URL Parameters

Name	String	Description
domain `Required`	String	The workspace domain.
execution_id `Required`	Integer	The numerical ID of the desired execution.
pipeline_id `Required`	Integer	The numerical ID of the desired pipeline.
project_name `Required`	String	The name ID of the project.

POST Parameters

Name	Type	Description
operation `Required`	String	Can be one of `RETRY`, `CANCEL`, `APPLY` or `APPLY_VARIABLES`.
variables	Variable[]	Required if `operation` is `APPLY_VARIABLES`.

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/executions/4

JSON

{
  "operation": "APPLY_VARIABLES",
  "variables": [
    {
      "key": "myVar1",
      "value": "someValue"
    }
  ]
}

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/executions/4",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/execution/56fa386c99f1e121d8b568b5",
  "id": 4,
  "start_date": "2016-03-29T08:12:04.132Z",
  "finish_date": null,
  "mode": "MANUAL",
  "refresh": false,
  "status": "INPROGRESS",
  "comment": "",
  "branch": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/branches/master",
    "html_url": "https://app.buddy.works/buddy/company-website/repository/branch/master",
    "name": "master",
    "default": true
  },
  "from_revision": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/506a3963507943d6908154f4bc9646e829128a08",
    "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/506a3963507943d6908154f4bc9646e829128a08",
    "revision": "506a3963507943d6908154f4bc9646e829128a08",
    "author_date": "2016-01-19T12:36:33Z",
    "commit_date": "2016-01-19T12:36:33Z",
    "message": "init repo\n",
    "committer": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
      "title": "Creative director"
    },
    "author": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
      "title": "Creative director"
    }
  },
  "to_revision": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/repository/commits/506a3963507943d6908154f4bc9646e829128a08",
    "html_url": "https://app.buddy.works/buddy/company-website/repository/commit/506a3963507943d6908154f4bc9646e829128a08",
    "revision": "506a3963507943d6908154f4bc9646e829128a08",
    "author_date": "2016-01-19T12:36:33Z",
    "commit_date": "2016-01-19T12:36:33Z",
    "message": "init repo\n",
    "committer": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
      "title": "Creative director"
    },
    "author": {
      "url": "https://api.buddy.works/workspaces/buddy/member/1",
      "html_url": "https://app.buddy.works/buddy/profile/1",
      "id": 1,
      "name": "Mike Benson",
      "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
      "title": "Creative director"
    }
  },
  "creator": {
    "url": "https://api.buddy.works/workspaces/buddy/member/1",
    "html_url": "https://app.buddy.works/buddy/profile/1",
    "id": 1,
    "name": "Mike Benson",
    "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
    "title": "Creative director"
  },
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "dev",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "last_execution_status": "INPROGRESS",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  },
  "action_executions": [
    {
      "status": "INPROGRESS",
      "progress": 0.0,
      "action": {
        "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/5",
        "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/5/edit",
        "id": 5,
        "name": "Upload files to dev",
        "type": "FTP",
        "trigger_time": "ON_EVERY_EXECUTION",
        "last_execution_status": "INPROGRESS"
      }
    }
  ]
}

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.

Cancel, Retry or Apply

Questions?

Sign up for Buddy Digest

Get started for free