Edit

PATCH
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions
/:action_id

Edits an action in the pipeline.

Warning

You can't change the type of an existing action. To change the type, remove the action and add it again. Models for all action types are the same as the model shown in Add Action examples

In post parameters you can use fields listed in the model for a given action.

Request

REQUIRED SCOPES

EXECUTION_MANAGE

URL PARAMETERS

action_idrequiredinteger

The numerical ID of the desired action.

workspacerequiredstring

The workspace name.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

project_namerequiredstring

The name ID of the project.

Last modified on Jan 19, 2026

List Delete

Request example


curl -X PATCH "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions/:action_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Upload files to Live mirror",
  "deployment_excludes": [
    "/assets/",
    "file.txt"
  ]
}'

Response

EXAMPLE RESPONSE
{
  "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 Live mirror",
  "type": "FTP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "SUCCESSFUL",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/",
  "remote_path": "",
  "login": "pass",
  "host": "localhost",
  "port": "21",
  "deployment_excludes": [
    "/assets/",
    "file.txt"
  ],
  "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"
  }
}