Failure detection API - POST a detection rule
Creates a new failure detection rule.
The new rule is appended to the end of the rule list. Rules are evaluated from top to bottom; the first matching rule applies. To enforce a particular order, use the reorder request.
The failure detection parameter set used by the rule must exist at the time of rule creation.
The request produces and consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/rules |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules |
Authentication
To execute this request, you need an access token with WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The body must not provide an ID. An ID is assigned automatically by Dynatrace and returned as part of the response.
To find all model variations that depend on the type of the model, see JSON models.
The JSON body of the request. Contains the configuration of the new failure detection rule.
Dynatrace will generate a random UUID for you, if you don't specify an ID.
Request body objects
The FailureDetectionRule object
Configuration of the failure detection rule.
A list of conditions of the rule.
The rule applies when all conditions are fulfilled.
A short description of the rule.
The rule is enabled (true) or disabled (false).
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.
The ID of the rule.
The display name of the rule.
The length of the name is limited to 150 characters.
The FailureDetectionCondition object
The condition of the failure detection rule.
The attribute to be checked.
PG_NAMEPG_TAGSERVICE_MANAGEMENT_ZONESSERVICE_NAMESERVICE_SERVICE_TYPESERVICE_TAG
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.
Defines the actual set of fields depending on the value. See one of the following objects:
STRING_EQUALS-> FdcPredicateStringEqualsSTRING_STARTS_WITH-> FdcPredicateStringStartsWithSTRING_ENDS_WITH-> FdcPredicateStringEndsWithSTRING_CONTAINS_SUBSTRING-> FdcPredicateStringContainsINTEGER_EQUALS-> FdcPredicateIntegerEqualsINTEGER_LESS_THAN-> FdcPredicateIntegerLessThanINTEGER_LESS_THAN_OR_EQUAL-> FdcPredicateIntegerLessThanOrEqualINTEGER_GREATER_THAN-> FdcPredicateIntegerGreaterThanINTEGER_GREATER_THAN_OR_EQUAL-> FdcPredicateIntegerGreaterThanOrEqualLONG_EQUALS-> FdcPredicateLongEqualsLONG_LESS_THAN-> FdcPredicateLongLessThanLONG_LESS_THAN_OR_EQUAL-> FdcPredicateLongLessThanOrEqualLONG_GREATER_THAN-> FdcPredicateLongGreaterThanLONG_GREATER_THAN_OR_EQUAL-> FdcPredicateLongGreaterThanOrEqualTAG_KEY_EQUALS-> FdcPredicateTagKeyEqualsTAG_EQUALS-> FdcPredicateTagEqualsSERVICE_TYPE_EQUALS-> FdcPredicateServiceTypeEqualsMANAGEMENT_ZONES_CONTAINS_ALL-> FdcPredicateManagementZonesContainsAllSET_OF_INTEGERS_CONTAINS_ANY-> FdcPredicateSetOfIntegersContainsAnySET_OF_INTEGERS_CONTAINS_ALL-> FdcPredicateSetOfIntegersContainsAll
INTEGER_EQUALSINTEGER_GREATER_THANINTEGER_GREATER_THAN_OR_EQUALINTEGER_LESS_THANINTEGER_LESS_THAN_OR_EQUALLONG_EQUALSLONG_GREATER_THANLONG_GREATER_THAN_OR_EQUALLONG_LESS_THANLONG_LESS_THAN_OR_EQUALMANAGEMENT_ZONES_CONTAINS_ALLSERVICE_TYPE_EQUALSSET_OF_INTEGERS_CONTAINS_ALLSET_OF_INTEGERS_CONTAINS_ANYSTRING_CONTAINS_SUBSTRINGSTRING_ENDS_WITHSTRING_EQUALSSTRING_STARTS_WITHTAG_EQUALSTAG_KEY_EQUALS
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"conditions": [{"attribute": "SERVICE_NAME","predicate": {"ignoreCase": false,"type": "STRING_STARTS_WITH","values": ["shp","stg_shp"]}}],"description": "for requests from shipping module","enabled": true,"fdpId": "FDP_9","id": "R_5","name": "shipping"}
Response
Response codes
Success. The new failure detection rule has been created. The response contains the ID of the new rule.
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
Response body JSON model
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/rules/validator |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/rules/validator |
Authentication
To execute this request, you need an access token with WriteConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
Success. The submitted configuration is valid. Response doesn't have a body.