Replace
Learn more about:
POST Parameters
| Name | Type | Description |
|---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to REPLACE. |
local_path Required | String | The path in the repository. |
| replacements | Replacement | The list of pairs of strings for replacement. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actionsJSON
{
"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"
}
]
}Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999JSON
{
"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"
}Last modified on November 16, 2022