• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Outage handling

Settings API - Outage handling schema table

Outage handling (builtin:synthetic.browser.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.browser.outage-handling
  • group:web-and-mobile-monitoring
  • group:web-and-mobile-monitoring.browser-monitor-default-settings
SYNTHETIC_TEST - Synthetic monitor
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.browser.outage-handling
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.browser.outage-handling
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.browser.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

PropertyLabelTypeDescriptionRequired
globalOutagesGenerate a problem and send an alert when the monitor is unavailable at all configured locations.boolean-required
globalConsecutiveOutageCountThresholdAlert if all locations are unable to access my web applicationinteger-required
localOutagesGenerate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.boolean-required
localLocationOutageCountThresholdAlert if at leastinteger-required
localConsecutiveOutageCountThresholdare unable to access my web applicationinteger-required
retryOnErrorAutomatic retry on error.boolean

When enabled, which is the default, failing monitor executions are retried immediately one time to avoid false positives and only the second result is used. When disabled, we use the first result right away. Requires ActiveGate version 1.207+ for private locations.

required