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 an action in the pipeline.

Required scopes: WORKSPACE, EXECUTION_MANAGE

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

Resource URL

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

URL Parameters

Name	Type	Description
action_id `Required`	Integer	The numerical ID of the desired action.
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

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

Example

Request

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

JSON

{
  "name": "Upload files to Live mirror",
  "deployment_excludes": [
     "/assets/",
     "file.txt"
     ]
}

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/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"
  }
}

Last modified on November 16, 2022

Edit

Knowledge is power!