Alerts raised by Redgate Monitor when a monitored server breaches a threshold or enters an unhealthy state. Includes both event alerts (e.g. deadlocks) and continuous alerts (e.g. sustained high CPU usage).

Operations

List all alert types

Returns all alert types available for querying, optionally filtered by the server types they support. Use the returned id values as alertIds in GET /alerts/data.

GET /api/v2/alerts

curl -G https://your-host/api/v2/alerts \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "supportedServerTypes=AmazonRdsHost"

Query parameters

supportedServerTypes array · entity-type · enum OPTIONAL

Match alert types that support at least one of the supplied server types. Repeat the parameter for multiple values. null returns all alert types regardless of server type.

See Entity types.

Responses

200 — The list of available alert types (empty array if none match)

Response object: Alert array

{
  "data": [
    {
      "id": "1:0",
      "name": "Processor (CPU) utilization",
      "description": "Processor (CPU) utilization on a host machine stays above a threshold percentage for longer than a specified duration",
      "supportedServerTypes": [
        "Machine",
        "AmazonRdsHost",
        "AmazonRdsSqlServer",
        "AzureManagedInstance",
        "LinuxMachine",
        "AzureFlexHost",
        "GoogleCloudHost"
      ]
    }
  ],
  "status": "success"
}

{
  "status": "fail",
  "data": {}
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "fail",
  "data": {}
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "status": "error",
  "message": "string"
}

List alert instances

Returns alert instances that were active at any point within the specified time range. For event alerts, "active" means the alert was raised within the window. For continuous alerts, it also includes alerts raised before startTime that were still firing at that time. When both startTime and endTime are omitted, the last hour is returned.

GET /api/v2/alerts/data

curl -G https://your-host/api/v2/alerts/data \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "startTime=2024-01-01T00:00:00Z" \
  --data-urlencode "endTime=2024-01-01T00:00:00Z" \
  --data-urlencode "entityIds=value" \
  --data-urlencode "alertIds=value" \
  --data-urlencode "severities=Low" \
  --data-urlencode "statuses=Event" \
  --data-urlencode "cleared=true"

Query parameters

startTime string · date-time OPTIONAL

Start of the time range (UTC). Defaults to one hour before endTime, or one hour before the current time when endTime is also omitted.

endTime string · date-time OPTIONAL

End of the time range (UTC). Must be later than startTime when startTime is provided. Defaults to the current time.

entityIds array · entity-id OPTIONAL

Optional entity IDs to restrict results to. Use the entityId values returned by GET /monitored-servers. Repeat the parameter for multiple values. Results are filtered down the hierarchy: supplying a cluster ID returns alerts for all SQL Server instances and databases on that cluster. Omit to return alerts for all monitored entities.

alertIds array · alert-type-id OPTIONAL

Optional alert type IDs to filter by. Use the id values returned by GET /alerts. Repeat the parameter for multiple values. Omit to return alerts of all types.

severities array · enum OPTIONAL

Optional severities to include. Repeat the parameter for multiple values. Omit to return alerts of all severities.

See AlertSeverity.

statuses array · enum OPTIONAL

Optional alert statuses to filter by. Filters on the alert's current state at the time of the response, not the state it was in during the queried time range. Accepted values: Event, Active, Ended. Repeat the parameter for multiple values. Omit to return alerts in all statuses.

See AlertStatus.

cleared boolean OPTIONAL

Optional filter for the cleared state. true returns only cleared alerts; false returns only non-cleared alerts. Omit to return both.

Responses

200 — Alert instances active within the requested time range

Response object: AlertData array

{
  "data": [
    {
      "alertId": "SqlServer.Performance.CpuUsage",
      "alertName": "CPU usage",
      "status": "Event",
      "cleared": false,
      "severity": "Low",
      "raisedTime": "2024-06-01T12:00:00Z",
      "endTime": "2024-06-01T12:15:00Z",
      "entityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,12:SqlServer,1,4:Name,s8:instance1,",
      "entityName": "instance1",
      "entityType": "SqlServer",
      "parentEntity": {
        "entityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,",
        "entityName": "prod-host-01",
        "entityType": "SqlServer",
        "parentEntity": null
      }
    }
  ],
  "status": "success"
}

{
  "status": "fail",
  "data": {}
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "fail",
  "data": {}
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "status": "error",
  "message": "string"
}