Settings API - Synthetic availability schema table
Synthetic availability (builtin:synthetic.synthetic-availability-settings)
Dynatrace offers the possibility to configure maintenance windows. By default maintenance windows only affect problem detection and alerting. You can change this behavior and calculate availability including/excluding maintenance window periods.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:synthetic.synthetic-availability-settings |
| environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.synthetic-availability-settings |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.synthetic-availability-settings | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.synthetic-availability-settings |
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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| excludeMaintenanceWindows | Exclude periods with maintenance windows from availability calculation | boolean | - | required |