Alerts API

About the Alerts API

CloudWisdom’s Alerts API can be used to get a list of alerts, get information about a specific alert, and close an open alert. You can test these endpoints by visiting our Swagger page and by clicking the interactive buttons below.

GET from /incidents

Use this endpoint to get a list of alerts and their IDs.

View method details.

GET from /incidents/{incidentId}

Use this endpoint to get information about an alert, such as violating metrics, specific events, elements affected, and start/stop timestamps.

View method details.

PUT to /incidents/{incidentId}

Use this endpoint to close an open alert.

View method details.

How to Find and Close an incident

The following is an example of how to use this API endpoint to find and close incidents.

1. Query a list of alerts using the elementName (or elementId), startDate, and isClosed parameters using the https://app.metricly.com/incidents request URL. This filters your results down to only open alerts which match a given period of time for a given element.

  • elementName: ExampleName
  • startDate: 2019-12-08
  • isClosed: False
 curl -X GET --header 'Accept: application/json' 'https://app.metricly.com/incidents?elementName=ExampleName&startDate=2019-12-08&isClosed=false'

2. Grab all relevant incidentIds from the JSON response for alerts you wish to close.

3. Close the alerts using the https://app.metricly.com/incidents/{incidentId-value-here} request URL, using the incidentIds obtained from your initial query.

curl -X PUT --header 'Accept: */*' 'https://app.metricly.com/incidents/11a1d11-1e01-1fe1-b1e1-1fe1db111111'

You can also use the policyId obtained from the same initial query if you do not know specifically which elements have been affected.