List

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 a list of all actions in the specified pipeline.

Required scopes: WORKSPACE, EXECUTION_INFO

Resource URL

GET /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions

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.

GET Parameters

Name	Type	Description
trigger_time	String	Specifies when the action should be executed. Can be one of `ON_EVERY_EXECUTION`, `ON_FAILURE`, `ON_BACK_TO_SUCCESS`, `ON_WARNING` or `ON_WAIT_FOR_APPROVE`.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

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",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/manage",
  "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 dev",
      "type": "FTP",
      "trigger_time": "ON_EVERY_EXECUTION",
      "last_execution_status": "SUCCESSFUL"
    }
  ]
}

Last modified on July 12, 2023

List

Knowledge is power!