YAML for Manage sandbox

View as Markdown

Manage sandbox operations like start, stop, snapshot, or delete.

YAML parameters for Manage sandbox

PARAMETERS
operationrequiredstring enum
The operation to perform on the sandbox
Allowed enum:
START,
STOP,
DELETE,
APP_START,
APP_STOP,
CREATE_SNAPSHOT,
APP_RESTART
typerequiredstring

Value: SANDBOX_MANAGE

actionrequiredstring
Unique identifier for the action within the pipeline.
targets(string | TargetYaml)[]
Array of sandbox targets to perform the operation on. Can be specific sandbox names or filters.
tagsstring[]
The set of tags for the sandbox
referenced_action_namestring
The name of the referenced action
snapshot_namestring
The name of the snapshot
trigger_timestring enum
Specifies when the action should be executed. ON_SUCCESS actions run after every successful run, also one ended by an EARLY_EXIT action.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
Names of the variables to loop over (IMAGES, not $IMAGES and not a value). The action runs once for each item of the value, and once for each combination of items when several variables are listed. The variable value is split into items by new lines, or by commas when it has no new lines (a single-line JSON object or key=value pairs stays one item). An item that is a JSON object or key=value pairs also sets one variable per key, named <VARIABLE>_<key>; an item that starts with EXTRACT: sets them as plain <key>.
run_only_on_first_failureboolean
When true, the action runs only on the first failure instead of on each failure. Used only when trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds. It cannot exceed the action time limit of the workspace plan; a higher value is rejected.
ignore_errorsboolean
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_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.

Constraints: ≤ 10

run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Nov 19, 2026

YAML examples for Manage sandbox

Start a sandbox via manage action

yaml
- action: "Start Sandbox"
  type: "SANDBOX_MANAGE"
  operation: START
  referenced_action_name: "Create Sandbox"

Stop a sandbox via manage action

yaml
- action: "Stop Sandbox"
  type: "SANDBOX_MANAGE"
  operation: STOP
  referenced_action_name: "Create Sandbox"

Delete a sandbox via manage action

yaml
- action: "Delete Sandbox"
  type: "SANDBOX_MANAGE"
  operation: DELETE
  referenced_action_name: "Create Sandbox"

Create a snapshot via manage action

yaml
- action: "Create Snapshot"
  type: "SANDBOX_MANAGE"
  operation: CREATE_SNAPSHOT
  snapshot_name: "snapshot-$BUDDY_RUN_ID"
  referenced_action_name: "Create Sandbox"

Start application via manage action

yaml
- action: "Start Application"
  type: "SANDBOX_MANAGE"
  operation: APP_START
  referenced_action_name: "Create Sandbox"

Stop application via manage action

yaml
- action: "Stop Application"
  type: "SANDBOX_MANAGE"
  operation: APP_STOP
  referenced_action_name: "Create Sandbox"

Restart application via manage action

yaml
- action: "Restart Application"
  type: "SANDBOX_MANAGE"
  operation: APP_RESTART
  referenced_action_name: "Create Sandbox"

Start Sandbox app with targets

yaml
- action: "Start Sandbox app"
  type: "SANDBOX_MANAGE"
  targets:
    - create-sb-node
  operation: APP_START

Restart Sandbox app with targets

yaml
- action: "Restart Sandbox app"
  type: "SANDBOX_MANAGE"
  targets:
    - create-sb-node
  operation: APP_RESTART

Stop Sandbox with targets

yaml
- action: "Stop Sandbox"
  type: "SANDBOX_MANAGE"
  targets:
    - create-new-sandbox
  operation: STOP

Create snapshot with filter

yaml
- action: "Create snapshot"
  type: "SANDBOX_MANAGE"
  targets:
    - target: create-*
      type: MATCH
      scope: PROJECT
      tags:
        - myTag
  snapshot_name: name-snapshot-$BUDDY_RUN_ID
  operation: CREATE_SNAPSHOT