Get
The documentation applies to models in the new version buddy.v1.1.0
For the REST API to work correctly, you should send the header X-Buddy-Media-Type: buddy.v1.1.0
You can read more about changes here.
Returns details of a single pipeline.
Required scopes: WORKSPACE
, EXECUTION_INFO
Resource URL
GET /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
pipeline_id Required | Integer | The numerical ID of the desired pipeline. |
project_name Required | String | The name ID of the project. |
Example
Request
GET https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2
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",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "INITIAL",
"last_execution_revision": null,
"create_date": "2016-02-29T11:23:12Z",
"project": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website",
"html_url": "https://app.buddy.works/buddy/company-website",
"name": "company-website",
"display_name": "Company Website",
"status": "ACTIVE"
},
"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"
},
"actions": [
{
"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 Live mirror",
"type": "FTP",
"trigger_time": "ON_EVERY_EXECUTION",
"status": "SUCCESSFUL",
"revision": null
}
],
"permissions": {
"others": "DENIED",
"users": [
{
"id": 2,
"access_level": "READ_ONLY"
}
],
"groups": [
{
"id": 1,
"access_level": "READ_ONLY"
}
]
}
}
last_execution_status
can be either SUCCESSFUL
, FAILED
, INPROGRESS
, ENQUEUED
, SKIPPED
, TERMINATED
, or INITIAL
Last modified on January 6, 2023