Failure detection API - PUT a parameter set
Updates the specified failure detection parameter set.
The request consumes an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| PUT | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets/{id} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/parameterSets/{id} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets/{id} |
Authentication
To execute this request, you need Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
To find all model variations that depend on the type of the model, see JSON models.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the required failure detection parameter set. | path | required |
| body | Failure | The JSON body of the request. Contains the updated failure detection parameter set. You can't update the ID with this request. Use the change ID request instead. | body | optional |
Request body objects
The FailureDetectionParameterSet object
A set of failure detection parameters (FDP).
These parameters define the conditions of failure and success.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the parameter set. The allowed characters are lowercase and uppercase letters, numbers, hyphens ( | optional |
| name | string | The display name of the FDP set. The length of the name is limited to 150 characters. | optional |
| description | string | A short description of the FDP set. | optional |
| clientSideMissingHttpCodeIsFailure | boolean | The missing HTTP response code on the client side is a failure ( If not set, | optional |
| serverSideMissingHttpCodeIsFailure | boolean | The missing HTTP response code on the server side is a failure ( If not set, | optional |
| failingHttpCodesClientSide | string | A list of client side HTTP response codes that are considered a failure. The format is a list of ranges and individual values (for example, If not set, the range of | optional |
| failingHttpCodesServerSide | string | A list of server side HTTP response codes that are considered a failure. The format is a list of ranges and individual values (for example, | optional |
| http404NotFoundFailureEnabled | boolean | Special handling of the 404 HTTP response code is enabled ( Only applicable when 404 is NOT in the list of failing HTTP response codes and only for the server side. If not set, | optional |
| brokenLinkDomains | string[] | A list of domains for the special handling of the 404 HTTP response code. If the top domain of the Referer is presented in the list OR equals the top domain of the request's host, the 404 code is considered a failure. Only applicable when isHttp404NotFoundFailureEnabled is set to | optional |
| successForcingExceptionPatterns | Exception | A list of success exceptions. If an exception on the entry node of the service matches any of these patterns it is considered a success. | optional |
| ignoredExceptionPatterns | Exception | A list of ignored exceptions. If an exception on the entry node of the service matches any of these patterns it is ignored by failure detection. | optional |
| exceptionOnAnyNodeExceptionPatterns | Exception | A list of faulty exceptions. If an exception on any node of the service matches any of these patterns it is considered a failure. | optional |
| tagConditions | Fdp | A list of tag-based conditions. If any condition is fulfilled the request is considered a failure. | optional |
The ExceptionPattern object
A list of faulty exceptions.
If an exception on any node of the service matches any of these patterns it is considered a failure.
| Element | Type | Description | Required |
|---|---|---|---|
| classPattern | string | - | optional |
| messagePattern | string | - | optional |
The FdpTagCondition object
Configuration of the tag condition in the FDP set.
| Element | Type | Description | Required |
|---|---|---|---|
| tagKey | string | The key of the tag to be checked. | required |
| predicate | Fdp | The predicate that tests the value of the tag. 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. | required |
The FdpTagPredicate object
The predicate that tests the value of the tag.
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 | Required |
|---|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
| required |
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.
{
"id": "FDP_9",
"name": "shipping",
"description": "for requests from shipping module",
"clientSideMissingHttpCodeIsFailure": false,
"serverSideMissingHttpCodeIsFailure": false,
"failingHttpCodesClientSide": "400-599",
"failingHttpCodesServerSide": "500-599",
"http404NotFoundFailureEnabled": false,
"brokenLinkDomains": [
"mydomain.com"
],
"successForcingExceptionPatterns": [
{
"classPattern": "NullPointerException",
"messagePattern": ""
}
],
"tagConditions": [
{
"tagKey": "myTag",
"predicate": {
"type": "STRING_EQUALS",
"value": "NG",
"ignoreCase": true
}
}
]
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 201 | Entity | Success. The new failure detection parameter set has been created. The response contains the ID of the new set. |
| 204 | - | Success. The failure detection parameter set has been updated. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
Response body objects
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| id | string | The ID of the Dynatrace entity. | required |
| name | string | The name of the Dynatrace entity. | optional |
| description | string | A short description of the Dynatrace entity. | optional |
Response body JSON model
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}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.
This request is an Early Adopter release and may be changed in non-compatible way.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets/{id}/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/failureDetection/parameterSelection/parameterSets/{id}/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/failureDetection/parameterSelection/parameterSets/{id}/validator |
Authentication
To execute this request, you need Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The submitted configuration is valid. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |