Custom action

  • 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 CUSTOM.
custom_typerequired 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_accessoptional boolean
Defines whether the action has access to the environment variables. Set to true on default.
filesystem_accessrequired 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.
inputsoptional Input[]
The list of objects including fields id and value with the input's name and its value.

Last modified on Sep 27, 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": "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"
    }
  ]
}'
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": "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999