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 the details of a single action in the specified pipeline.
Required scopes: WORKSPACE
, EXECUTION_INFO
Resource URL
GET /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions/:action_id
URL Parameters
Name | Type | Description |
---|---|---|
action_id Required | String | The numerical ID of the desired action. |
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/actions/5
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/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": "SUCCESSFUL",
"deployment_excludes": [
"/assets/",
"file.txt"
],
"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": "Live mirror",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
status
can be either SUCCESSFUL
, FAILED
, INPROGRESS
, ENQUEUED
, SKIPPED
, TERMINATED
, or INITIAL
Last modified on April 26, 2022