Failure detection API - GET a detection rule
Gets the specified failure detection rule.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules/{id} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/rules/{id} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules/{id} |
Authentication
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required failure detection rule. Needs to be a valid RFC 4122 UUID. | path | required |
Response
To find all model variations that depend on the type of the model, see JSON models.
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Failure | Success |
| 404 | Failed. The specified entity doesn't exist. |
Response body objects
The FailureDetectionRule object
Configuration of the failure detection rule.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the rule. |
| name | string | The display name of the rule. The length of the name is limited to 150 characters. |
| description | string | A short description of the rule. |
| enabled | boolean | The rule is enabled ( |
| fdpId | string | The failure detection parameter (FDP) set of the rule. Specify the ID of the set here. The FDP set must exist at the time of rule creation. |
| conditions | Failure | A list of conditions of the rule. The rule applies when all conditions are fulfilled. |
The FailureDetectionCondition object
The condition of the failure detection rule.
| Element | Type | Description |
|---|---|---|
| attribute | string | The attribute to be checked. |
| predicate | Fdc | The predicate that tests the value of the attribute. The actual set of fields depends on the type of the predicate. Find the list of actual objects in the description of the type field or see Failure detection API - JSON models. |
The FdcPredicate object
The predicate that tests the value of the attribute.
The actual set of fields depends on the type of the predicate. Find the list of actual objects in the description of the type field or see Failure detection API - JSON models.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
Response body JSON model
{
"id": "R_5",
"name": "shipping",
"description": "for requests from shipping module",
"enabled": true,
"fdpId": "FDP_9",
"conditions": [
{
"attribute": "SERVICE_NAME",
"predicate": {
"type": "STRING_STARTS_WITH",
"ignoreCase": false,
"values": [
"shp",
"stg_shp"
]
}
}
]
}