YAML for Web monitoring

View as Markdown

Test HTTP connection and optionally verify response content.

YAML parameters for Web monitoring

PARAMETERS
destinationrequiredstring
The destination address for the network action
typerequiredstring

Value: WEB

actionrequiredstring
Unique identifier for the action within the pipeline.
portstring
The port number for the HTTP request
loginstring
The login username for HTTP authentication
passwordstring
The password for HTTP authentication
headersHeaderYaml[]
The HTTP headers to include in the request
post_datastring
The POST data to send with the request
textstring
The text to search for in the response
text_existenceboolean
If set to true, the action will succeed if the text is found; if false, it will succeed if the text is not found
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
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
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 2, 2026

YAML examples for Web monitoring

Web health check with authentication

yaml
- action: Web health check
  type: WEB
  trigger_time: ON_EVERY_EXECUTION
  disabled: false
  destination: https://api.example.com/health
  port: "443"
  login: testuser
  password: testpass123
  headers:
    - name: Authorization
      value: Bearer token123
    - name: X-Custom-Header
      value: custom-value
  post_data: '{"check": "health"}'
  text: OK
  text_existence: true
  ignore_errors: false
  retry_interval: 30
  retry_count: 2
  timeout: 60

Simple web check

yaml
- action: Web check
  type: WEB
  trigger_time: ON_EVERY_EXECUTION
  destination: https://example.com