Replace

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /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 REPLACE.
local_pathrequired string
The path in the repository.
replacementsrequired Replacement[]
The list of pairs of strings for replacement.

Last modified on Oct 7, 2024

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": "Replace values",
  "type": "REPLACE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "local_path": "/",
  "replacements": [
    {
      "replace_from": "[ENV]",
      "replace_to": "stage"
    },
    {
      "replace_from": "multiline",
      "replace_to": "Replace\nmultiline\nstring"
    }
  ]
}'
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": "Replace values", "type": "REPLACE", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "local_path": "/", "replacements": [ { "replace_from": "[ENV]", "replace_to": "stage" }, { "replace_from": "multiline", "replace_to": "Replace\nmultiline\nstring" } ], "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" }, "revision": "236afa836c2b5902077859c558efbd11351dcaac" }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999