Custom action
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 CUSTOM. |
custom_type Required | String | The action's name from the Custom Action definition. Can include tag (see: example). If not included, it's set to latest on default. |
| variable_access | Boolean | Defines whether the action has access to the environment variables. Set to true on default. |
| filesystem_access | Boolean | Defines whether the action has access to the filesystem. Required if volume_mappings is defined within the action's definition. Set to false on default. |
| inputs | Input[] | The list of objects including fields id and value with the input's name and its value. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actionsJSON
{
"name": "My custom action",
"type": "CUSTOM",
"trigger_time": "ON_EVERY_EXECUTION",
"custom_type": "my_custom_action:latest",
"variables_access": true,
"filesystem_access": true,
"inputs": [
{
"id": "cmd",
"value": "echo 'Hello world'"
},
{
"id": "other_custom_input",
"value": "some value"
}
]
}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": "My custom action",
"type": "CUSTOM",
"trigger_time": "ON_EVERY_EXECUTION",
"custom_type": "my_custom_action:latest",
"variables_access": true,
"filesystem_access": true,
"inputs": [
{
"id": "cmd",
"value": "echo 'Hello world'"
},
{
"id": "other_custom_input",
"value": "some value"
}
],
"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",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}Last modified on December 5, 2022