Alerts (Incidents) and Events (REST)

GET Alerts

Lists all alerts, fitting the filter criteria.

If no start and end date is specified, a default time frame of three days is selected.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/alerts
  • AppMon 2018 April https://{server}:8021/api/v3/alerts
  • AppMon 2018 October https://{server}:8021/api/v4/alerts

POST Alerts

Creates an alert (incident) for the specified System Profile and Incident Rule.

If the request does not contain a start and end date, the current server time will be used.

The default severity is informational and the default state is Created.

Alerts with informational severity are automatically set to the Confirmed state. You can set such alerts to other states with a subsequent update.

It is possible to specify the start date and leave the end date unset. The end date can then be provided later with an update.

At least three JSON properties: systemprofile, incidentrule, and message must specified.

The request consumes application/json.

POST
  • AppMon 2017 May https://{server}:8021/api/v2/alerts
  • AppMon 2018 April https://{server}:8021/api/v3/alerts
  • AppMon 2018 October https://{server}:8021/api/v4/alerts

PUT Alert

Updates an existing alert. You can use the GET Alert request first, then modify the required parameters of its response, or you can send several requests, modifying one property at time.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/alerts/{alert}
  • AppMon 2018 April https://{server}:8021/api/v3/alerts/{alert}
  • AppMon 2018 October https://{server}:8021/api/v4/alerts/{alert}

GET Alert

Inquires information about specified alert.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/alerts/{alert}
  • AppMon 2018 April https://{server}:8021/api/v3/alerts/{alert}
  • AppMon 2018 October https://{server}:8021/api/v4/alerts/{alert}

DELETE Alert

Deletes the specified alert.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/alerts/{alert}
  • AppMon 2018 April https://{server}:8021/api/v3/alerts/{alert}
  • AppMon 2018 October https://{server}:8021/api/v4/alerts/{alert}

Alert suppressions

See Alerts suppression (REST).

Deployment events

See Deployment events (REST).