Settings API - Outage handling schema table

  • Published Jul 31, 2024

Outage handling (builtin:synthetic.multiprotocol.outage-handling)

Dynatrace can generate problems for both global outages and/or local outages based on the availability of either all configured locations or only individual locations over consecutive runs.

Schema IDSchema groupsScope
builtin:synthetic.multiprotocol.outage-handling
  • group:web-and-mobile-monitoring
  • group:synthetic.multiprotocol
  • group:web-and-mobile-monitoring.multiprotocol-monitor-default-settings
MULTIPROTOCOL_MONITOR - Network availability monitor
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.multiprotocol.outage-handling
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.multiprotocol.outage-handling
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.multiprotocol.outage-handling

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Generate a problem and send an alert when the monitor is unavailable at all configured locations.
globalOutages		boolean-Required
Alert if all locations are unable to access my target address
globalConsecutiveOutageCountThreshold		integer-Required
Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.
localOutages		boolean-Required
Alert if at least
localLocationOutageCountThreshold		integer-Required
are unable to access my target address
localConsecutiveOutageCountThreshold		integer-Required