Alerts
Published 03 April 2024
The Alerts endpoints allow you to retrieve alert types and alerts for a certain date range. Additional documentation for this endpoint can be found by navigating to http://your-web-server:port/api-docs.
Alert Types
/api/v1/alerts/types
The alert types endpoint provides a list of alert types in Redgate monitor that are required to query alerts using the alerts endpoint.
Attributes
| id | The unique identifier for the alert type |
|---|---|
| name | Name of the alert type |
| description | Description of the alert type |
| shortName | Alternate name of alert type |
Limitation
| Rate limit | Defaults to 100 API requests per minute, you can refer rate limiting to change these default values. |
|---|
Alerts
/api/v1/alerts
The alerts endpoint provides a list of alerts for a given alert type
This endpoint consists of a large amount of Data, It is recommended that you use the query parameters where possible to limit the amount of data returned by the endpoints.
Parameters
| Name | Mandatory/Optional | Type | Default | Description |
|---|---|---|---|---|
| AlertTypeId | Mandatory | String | None | Alert type ID which can be retrieved from the alert types endpoint |
| MonitoredEntityId | Optional | String | None | Monitored entity ID which can be retrieved from the monitored entities endpoint, can be used to restrict the result to a single monitored entity |
| Start | Optional | DateTime | current DateTime - 1hour | The date and time used to filter the alerts on the time the alert was raised, can be used to retrieve alerts raised after the specified date and time. |
| End | Optional | DateTime | current DateTime | The date and time used to filter the alerts on the time the alert was raised, can be used to retrieve alerts raised before the specified date and time. |
| Limit | Optional | Number | 1000 | The number of records fetched from a single api request. |
Attributes
| id | The unique identifier of an alert |
|---|---|
| monitoredEntity | id and name of the monitored entity the alert was raised on. |
| sourceName | Name of the source at which the alert is triggered |
| status | Status of the alert, possible values are (Event, Active, Ended, Cleared) |
| severity | The severity of the alert, possible values (High, Medium, Low) |
| raisedAt | DateTime at which the alert was raised |
| endedAt | The time at which the alert was ended, this field will contain a value only when the alert status in Ended |
| alertType | The ID and name of the alert type |
Limitation
| Date Range | Maximum range of 7 Days |
|---|---|
| Rate limit | Defaults to 100 API requests per minute, you can refer rate limiting to change these default values. |
