Edit

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.

Edits a pipeline in the project.

Required scopes: WORKSPACE, EXECUTION_MANAGE

Resource URL

PATCH /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.

POST Parameters

Name	Type	Description
name	String	The name of the pipeline.
on	String	The trigger mode of the pipeline. Can be one of `CLICK`, `EVENT`, `SCHEDULE`.
refs	String[]	Set it if `on` is set to `CLICK` or `SCHEDULE`. The list of refs for which the pipeline will be triggered. Automatically set to `NONE` if not provided.
events	Event[]	The list of events for which the pipeline will be triggered. Set it if `on` is set to `EVENT`.
trigger_conditions	TriggerCondition[]	The list of trigger conditions to meet so that the pipeline can be triggered.
last_execution_revision	String	The hash of the commit that is currently deployed on the server.
start_date	iso 8601 utc date	Required if the pipeline is set to `on: SCHEDULE` and no `cron` is specified. Defines when the pipeline execution should start. Format: 2016-11-18T12:38:16.000Z
delay	Integer	Required if the pipeline is set to `on: SCHEDULE` and no `cron` is specified. Defines the intervals in which the pipeline should be executed (in minutes).
cron	String	Required if the pipeline is set to `on: SCHEDULE` and neither `start_date` nor `delay` is specified. The standard CRON expression defining the execution schedule.
paused	Boolean	Defines if the recurrent pipeline executions are paused or not. Restricted to `on: SCHEDULE`.
always_from_scratch	Boolean	Defines whether or not to upload everything from scratch on every execution.
auto_clear_cache	Boolean	Defines whether or not to automatically clear cache before running the pipeline .
no_skip_to_most_recent	Boolean	Defines whether or not to skip execution to the most recent.
omit_status_sending	Boolean	Defines whether or not to omit sending commit statuses to Github or Gitlab upon execution.
target_site_url	String	The URL of the target website.
disabled	Boolean	Set it, if you want the pipeline to be disabled.
disabled_reason	String	Specifies the reason for disabling the pipeline.
concurrent_pipeline_runs	Boolean	Defines whether or not the pipeline can be run concurrently.
permissions	PipelinePermissions	Define to set permissions for the pipeline.

Example

Request

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

JSON

{
  "name": "Tests",
  "on": "EVENT",
  "events": [
    {
      "type": "PUSH",
      "refs": [
        "refs/heads/master"
      ]
    }
  ],
  "execution_message_template": "test",
  "always_from_scratch": true,
  "auto_clear_cache": true,
  "no_skip_to_most_recent": true,
  "do_not_create_commit_status": true,
  "ignore_fail_on_project_status": true,
  "concurrent_pipeline_runs": true,
  "permissions": {
    "others": "DENIED",
    "users": [
      {
        "id": 1,
        "access_level": "READ_WRITE"
      }
    ],
    "groups": [
      {
        "id": 1,
        "access_level": "READ_ONLY"
      }
    ]
  }
}

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": "Tests",
  "on": "EVENT",
  "events": [
    {
      "type": "PUSH",
      "refs": [
        "refs/heads/master"
      ]
    }
  ],
  "execution_message_template": "test",
  "last_execution_status": "INITIAL",
  "last_execution_revision": null,
  "create_date": "2016-03-29T07:12:30.675Z",
  "always_from_scratch": true,
  "auto_clear_cache": true,
  "no_skip_to_most_recent": true,
  "do_not_create_commit_status": true,
  "ignore_fail_on_project_status": true,
  "concurrent_pipeline_runs": true,
  "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": [

  ],
  "permissions": {
    "others": "DENIED",
    "users": [
      {
        "id": 2,
        "access_level": "READ_ONLY"
      }
    ],
    "groups": [
      {
        "id": 1,
        "access_level": "READ_ONLY"
      }
    ]
  }
}

Last modified on January 9, 2023

Edit

Knowledge is power!