Run execution

Runs the execution of the pipeline.

Required scopes: WORKSPACE, EXECUTION_RUN

Resource URL

POST /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/executions

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
pipeline_id
Required
IntegerThe numerical ID of the desired scenario.
project_name
Required
StringThe name ID of the project.

POST Parameters

NameTypeDescription
to_revision
Required
StringThe revision or HEAD from the repository that will be executed in the pipeline.
variablesVariable[]The list of variables to set as parameters for the pipeline.
branchStringThe name of the branch to be executed when the pipeline is set to the wildcard ref_type.
tagStringThe name of the tag to be executed when the pipeline is set to the wildcard ref_type.
commentStringExecution comment.
refreshBooleanDeploy from scratch.
clear_cacheBooleanClear cache before running the pipeline.

Example

Request

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

JSON

{
"to_revision": {
"revision": "HEAD"
},
"comment": "hotfix",
"clear_cache": true,
"variables": [
{
"key": "version",
"value": "1.0"
},
{
"key": "pass",
"value": "qwerty",
"encrypted": true
}
]
}

Request

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

JSON

{
"branch": {
"name": "master"
},
"comment": "hotfix"
}

Request

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

JSON

{
"tag": {
"name": "v1.0"
},
"comment": "hotfix"
}

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/3",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/execution/56fa37f499f1e10c105fb388",
"id": 3,
"start_date": "2016-03-29T08:08:20.205Z",
"finish_date": null,
"mode": "MANUAL",
"refresh": false,
"status": "INPROGRESS",
"comment": "hotfix",
"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",
"run_only_on_first_failure": false
}
}
]
}