Replace

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to REPLACE.
local_path
Required
StringThe path in the repository.
replacementsReplacementThe list of pairs of strings for replacement.

Example

Request

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

JSON

{
"name": "Replace values",
"type": "REPLACE",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"local_path": "/",
"replacements": [
{
"replace_from": "[ENV]",
"replace_to": "stage"
},
{
"replace_from": "multiline",
"replace_to": "Replace\nmultiline\nstring"
}
]
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"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",
"trigger_condition": "ALWAYS",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
},
"revision": "236afa836c2b5902077859c558efbd11351dcaac"
}