Edit

  • PATCH
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id

Edits a pipeline in the project.

Request

REQUIRED SCOPES
WORKSPACE, EXECUTION_MANAGE
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
namestring
The name of the pipeline.
refsstring[]
Refs for manual pipeline triggers; if unset and Events is empty, the pipeline counts as codeless.
eventsEvent[]
The list of events for which the pipeline will be triggered. Set it if on is set to EVENT.
trigger_conditionsTriggerCondition[]
The list of trigger conditions to meet so that the pipeline can be triggered.
last_execution_revisionstring
The hash of the commit that is currently deployed on the server.
pausedboolean
Defines if the recurrent pipeline executions are paused or not. Restricted to SCHEDULE event.
pause_on_repeated_failuresInteger
Pauses the pipeline after n failed pipeline runs. Restricted to pipelines set SCHEDULEevent. Possible values: 1-100 (the default value is 100).
always_from_scratchboolean
Defines whether or not to upload everything from scratch on every execution.
auto_clear_cacheboolean
Defines whether or not to automatically clear cache before running the pipeline.
no_skip_to_most_recentboolean
Defines whether or not to skip execution to the most recent.
omit_status_sendingboolean
Defines whether or not to omit sending commit statuses to Github or Gitlab upon execution.
target_site_urlstring
The URL of the target website.
disabledboolean
Set it, if you want the pipeline to be disabled.
disabled_reasonstring
Specifies the reason for disabling the pipeline.
variablesVariable[]
List of variables defined for that pipeline.
concurrent_pipeline_runsboolean
Defines whether or not the pipeline can be run concurrently.
git_changeset_basestring
Defines the way the changeset for deployments and trigger conditions between subsequent executions in the pipeline will be calculated. Available values: LATEST_RUN, LATEST_RUN_MATCHING_REF, PULL_REQUEST. By default, it is set to LATEST_RUN.
filesystem_changeset_basestring
Defines changeset calculation method whenever deployment action has input_type set to BUILD_ARTIFACTS. Default set to DATE_MODIFIED. Possible values: DATE_MODIFIED, CONTENTS.
permissionsPipelinePermissions
Define to set permissions for the pipeline.

Last modified on Feb 6, 2025

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Tests",
  "events": [
    {
      "type": "PUSH",
      "refs": [
        "refs/heads/main",
        "refs/heads/dev-*"
      ]
    },
    {
      "type": "PULL_REQUEST",
      "events": [
        "assigned",
        "unassigned"
      ],
      "branches": [
        "main",
        "relesaes/*"
      ]
    },
    {
      "type": "SCHEDULE",
      "start_date": "2025-01-01T08:00:00.000Z",
      "delay": 60,
      "refs": [
        "refs/heads/development"
      ]
    }
  ],
  "variables": [
    {
      "key": "my_var",
      "value": "some_value"
    }
  ],
  "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,
  "filesystem_changeset_base": "CONTENTS",
  "concurrent_pipeline_runs": true,
  "git_changeset_base": "LATEST_RUN_MATCHING_REF",
  "permissions": {
    "others": "DENIED",
    "users": [
      {
        "id": 1,
        "access_level": "READ_WRITE"
      }
    ],
    "groups": [
      {
        "id": 1,
        "access_level": "READ_ONLY"
      }
    ]
  }
}'
EXAMPLE RESPONSE
{ "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", "events": [ { "type": "PUSH", "refs": [ "refs/heads/main", "refs/heads/dev-*" ] }, { "type": "PULL_REQUEST", "events": [ "assigned", "unassigned" ], "branches": [ "main", "releases/*" ] }, { "type": "SCHEDULE", "start_date": "2025-01-01T08:00:00.000Z", "delay": 60, "refs": [ "refs/heads/development" ] } ], "variables": [ { "url": "https://api.buddy.works/workspaces/buddytest/variables/1", "type": "VAR", "id": 1, "key": "my_var", "value": "some_value", "encrypted": false } ], "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, "git_changeset_base": "LATEST_RUN_MATCHING_REF", "filesystem_changeset_base": "CONTENTS", "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" } ] } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999