Add action
Adds a new action to the specified pipeline.
Required scopes: WORKSPACE, EXECUTION_MANAGE
Resource URL
POST /workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actionsURL Parameters
| Name | Type | Description |
|---|---|---|
domain Required | String | The workspace domain. |
pipeline_id Required | Integer | The numerical ID of the desired pipeline. |
project_name Required | String | The name ID of the project. |
Actions schema
Properties
| Name | Type | Description |
|---|---|---|
name Required | String | The ID of the action. |
type Required | String | The type of the action. |
| trigger_conditions | TriggerCondition[] | The list of trigger conditions to meet so that the action can be triggered. |
| variables | Variable[] | The list of variables you can use the action. |
| after_action_id | Integer | The numerical ID of the action, after which this action should be added. |
| timeout | Integer | The timeout in seconds. |
| disabled | Boolean | When set to true the action is disabled. By default it is set to false. |
| run_next_parallel | Boolean | When set to true, the subsequent action defined in the pipeline will run in parallel to the current action. |
| run_only_on_first_failure | Boolean | Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE. |
| ignore_errors | Boolean | If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions. |
| retry_interval | Integer | Delay time between auto retries in seconds. |
| retry_count | Integer | Number of retries if the action fails. |
| trigger_time | String | Specifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE, ON_BACK_TO_SUCCESS, ON_WARNING or ON_WAIT_FOR_APPROVE. The default value is ON_EVERY_EXECUTION. |
On top of these properties every action has a set of properties unique to its type. You can read how to define each type in separate articles below.
Last modified on July 12, 2023