Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for Sandbox Application Start

View as Markdown

Start an application in a sandbox.

YAML parameters for Sandbox Application Start

PARAMETERS
sandbox_referencesrequiredstring[]
The set of sandbox reference types
typerequiredstring

Value: SANDBOX_APPLICATION_START

actionrequiredstring
Unique identifier for the action within the pipeline.
sandbox_namestring
The name of the sandbox
snapshot_idstring
The ID of the snapshot
sandbox_distributionstring
The distribution used for the sandbox
resourcesstring enum
The resource allocation for the sandbox
Allowed enum:
SIZE_1x2,
SIZE_2x4,
SIZE_3x6,
SIZE_4x8,
SIZE_5x10,
SIZE_6x12,
SIZE_7x14,
SIZE_8x16,
SIZE_9x18,
SIZE_10x20,
SIZE_11x22,
SIZE_12x24,
CUSTOM
return_existingboolean
If set to true, an existing sandbox will be returned
sandbox_idstring
The ID of the sandbox to use (when sandbox_references includes BY_ID)
sandbox_project_idinteger
The ID of the sandbox project
sandbox_project_namestring
The name of the sandbox project
tagsstring[]
The set of tags for the sandbox
referenced_sandbox_namestring
The name of the referenced sandbox
daysinteger
The number of days for sandbox retention
referenced_action_namestring
The name of the referenced action
referenced_action_idinteger
The ID of the referenced action
snapshot_namestring
The name of the snapshot
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the 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.
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.
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 Jul 31, 2025

Previous pageRun Docker containerNext pageSandbox Application Stop

YAML examples for Sandbox Application Start

Start application in a sandbox

yaml
  - action: "Start Sandbox Application"
    type: "SANDBOX_APPLICATION_START"
    sandbox_references:
      - BY_ID
    sandbox_id: "$SANDBOX_ID"

Start application by sandbox name

yaml
  - action: "Start Sandbox Application"
    type: "SANDBOX_APPLICATION_START"
    sandbox_references:
      - BY_NAME
    sandbox_name: "my-sandbox"