Settings API - Site Reliability Guardian schema table
Site Reliability Guardian (app:dynatrace.site.reliability.guardian:guardians)
Create new guardians and add objectives. See documentation
| Schema ID | Schema groups | Scope |
|---|---|---|
app:dynatrace.site.reliability.guardian:guardians | - | environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.site.reliability.guardian:guardians |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:dynatrace.site.reliability.guardian:guardians | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.site.reliability.guardian:guardians |
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 |
|---|---|---|---|---|
| name | Name | text | - | required |
| description | Description | text | - | optional |
| tags | Tags | set | Define key/value pairs that further describe this guardian. | required |
| variables | DQL variables | list | Define variables for dynamically defining DQL queries | required |
| objectives | Objectives | list | - | required |
Request body objects
The Variable object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Name | text | - | required |
| definition | Value | text | - | required |
The Objective object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Objective name | text | - | required |
| description | Description | text | - | optional |
| objectiveType | Objective type | enum | - | required |
| dqlQuery | DQL query | text | - | required |
| referenceSlo | Reference SLO | text | Please enter the metric key of your desired SLO. SLO metric keys have to start with 'func:slo.' | required |
| comparisonOperator | Comparison operator | enum | - | required |
| target | Target | float | - | optional |
| warning | Warning | float | - | optional |