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

YAML for TCP monitoring

View as Markdown

Test TCP connection to a host and port.

YAML parameters for TCP monitoring

PARAMETERS
portrequiredstring
The TCP port number to connect to
destinationrequiredstring
The destination address for the network action
typerequiredstring

Value: TCP

actionrequiredstring
Unique identifier for the action within the pipeline.
post_datastring
The data to send to the TCP server
textstring
The text to search for in the response
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 pageTag Docker ImageNext pageTelegram notification

YAML examples for TCP monitoring

TCP database check

yaml
  - action: TCP database check
    type: TCP
    trigger_time: ON_EVERY_EXECUTION
    disabled: false
    destination: db.example.com
    port: "5432"
    text: PostgreSQL
    post_data: SELECT 1
    ignore_errors: false
    retry_interval: 30
    retry_count: 2
    timeout: 60

Simple TCP check

yaml
  - action: TCP check
    type: TCP
    trigger_time: ON_EVERY_EXECUTION
    destination: localhost
    port: "3306"