List pipelines

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 pipelines from the project. Pipeline hidden with the visibility settings will not be fetched.

Required scopes: WORKSPACE, EXECUTION_INFO

Resource URL

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

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
project_name
Required
StringThe name ID of the project.

GET Parameters

NameTypeDescription
pageIntegerThe number of the successive page (results are splitted by pages of per_page elements each).
per_pageIntegerThe number of returned elements on the page.
sort_byStringSpecifies the ordering. Can be one of name or id.
sort_directionStringSpecifies the direction of the ordering. Can be one of ASC or DESC.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines?sort_by=name&sort_direction=ASC&page=1&per_page=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",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines",
  "pipelines": [
    {
      "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",
      "on": "CLICK",
      "refs": [
        "refs/heads/master"
      ],
      "last_execution_status": "SUCCESSFUL",
      "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
    }
  ]
}