Trigger pipeline

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

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to RUN_NEXT_PIPELINE.

next_pipelinerequired Pipeline

The next pipeline that will be executed.

commentstring

The next pipeline execution comment.

revisionstring

Can be one of HEAD, INHERIT or SPECIFIC. Default is HEAD.

specific_revisionstring

Set if you want to run the pipeline for a specific revision or ref.

clear_cacheboolean

Set to true if you want the execution to run with the clear_cache flag. Default is false.

refreshboolean

Set to true if you want the execution to run from scratch. Default is false.

priorityExecutionPriority

Set if you want the execution to run with priority other than set in the next pipeline. Can be one of LOW, NORMAL or HIGH.

Last modified on Oct 29, 2024

Transfer to a sandbox Upcloud (Password)

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Trigger Pipeline Action",
  "type": "RUN_NEXT_PIPELINE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "next_project_name": "backend",
  "next_pipeline_name": "dev",
  "comment": "Trigger next pipeline",
  "revision": "SPECIFIC",
  "specific_revision": "$BUDDY_RUN_REF",
  "next_pipeline": {
    "id": 3
  },
  "clear_cache": true,
  "refresh": true,
  "priority": "HIGH",
  "variables": [
    {
      "key": "ftp_login",
      "value": "userLogin123",
      "description": "The login to the FTP.",
      "encrypted": false,
      "settable": false
    },
    {
      "key": "ftp_password",
      "value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
      "description": "The password to the FTP.",
      "encrypted": true
    }
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
  "id": 2,
  "name": "Trigger Pipeline Action",
  "type": "RUN_NEXT_PIPELINE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "next_project_name": "backend",
  "next_pipeline_name": "dev",
  "last_execution_status": "INITIAL",
  "comment": "",
  "revision": "236afa836c2b5902077859c558efbd11351dcaac",
  "specific_revision": "$BUDDY_RUN_REF",
  "clear_cache": true,
  "refresh": true,
  "priority": "HIGH",
  "variables": [
    {
      "key": "ftp_login",
      "value": "userLogin123",
      "description": "The login to the FTP.",
      "encrypted": false,
      "settable": false
    },
    {
      "key": "ftp_password",
      "value": "secure!14ivLMxPgv7TX6c9+ITX/g==",
      "description": "The password to the FTP",
      "encrypted": true
    }
  ],
  "next_pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/310",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/310",
    "id": 3,
    "name": "test",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "INITIAL",
    "last_execution_revision": null
  },
  "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
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999