YAML for Datadog Service Check

Submit a service check status to Datadog.

YAML parameters for Datadog Service Check

PARAMETERS
integrationrequiredstring
Datadog integration (DATADOG)
typerequiredstring

Value: DATADOG_STATUS_CHECK

actionrequiredstring
Unique identifier for the action within the pipeline.
messagestring
A description of why this status occurred
checkstring
The text for the message
host_namestring
The Host name to associate with the event. Any tags associated with the host will also be applied to this event
statusinteger
An integer for the status of the check
regionstring enum
The Datadog region. Can be one of US1, US3, US5, EU1, AP1, US1_FED. If not set, the default is US1
Allowed enum:
US1,
US3,
US5,
EU1,
AP1,
US1_FED,
EU,
NA
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

YAML examples for Datadog Service Check

Datadog service check

yaml
- action: "Datadog service check" type: "DATADOG_STATUS_CHECK" integration: "datadog_integration" region: "US1" check: "app.deployment.status" message: "Deployment completed successfully" host_name: "app-server-01.example.com" status: 0