Incident downtime (REST)

Overview

You can define Incident Rules to perform actions such as sending an email if a specified threshold is violated. In the case of planned actions such as system backups, database mirroring, or server restarts, you can suppress incidents. Learn how to configure this in Incident Downtimes.

Use the AppMon Server RESTful services at https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes/<downtimename> to manage incident suppression.

Examine details with HTTP GET requests and use HTTP PUT / DELETE to add or update / delete a planned incident downtime.

List all incident downtimes

GET https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes Produces application/xml

Lists all existing incident downtimes for a specific profile. The response contains the URL and the name of each downtime.

GET incident downtimes

GET https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes/<downtimename> Produces application/xml

Gets the XML representation of an existing incident downtime.

Add or update incident downtimes

Use the HTTP PUT interface to create or overwrite an incident downtime by sending an XML representation as request content. The expected XML structure of the request content is similar to the response of the corresponding HTTP GET interface. Permissions are required to write to the System Profile configuration. An overloading POST interface provides the same output as HTTP PUT.

PUT https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes/<downtimename> Consumes application/xml
POST https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes/<downtimename>?httpMethod=PUT consumes application/xml

Delete incident downtimes

DELETE https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes/<downtimename>
POST https://<server>:8021/rest/management/profiles/<profilename>/incidentdowntimes/<downtimename>?httpMethod=DELETE

Deletes an existing incident downtime.

Questions and answers

Does the name of an incident downtime needs to be unique?

The name of the incident downtime is used as identifier and needs to be unique over all system profiles.

Why does the PUT or DELETE interface return HTTP 403 error message, Downtime X must not be modified because it doesn't relate exclusively to system profile Y

Possible reasons are:

  • The incident downtime you are trying to modify relates to a system profile Y, but you have used a REST URI for another system profile.
  • You are trying to create an incident downtime that already exists and belongs to a different system profile.
  • The incident downtime you are trying to modify must belong to exactly one system profile. If the incident downtime relates to multiple profiles or doesn't belong to any system profile, you have to use AppMon Client to manage it.

Is it possible to manage incident downtimes on incident rule level?

Within AppMon Client it is possible to manage downtimes on system profile and incident rule level. With the REST interfaces you can manage downtime only on the system profile level (marked green below), but not on the incident rule level.