Skip to content

Alerts API

Manage alerts and alert rules.

List Alerts

http
GET /api/v1/alerts

Query Parameters

ParameterTypeDescription
statusstringFilter by status (firing, resolved, silenced)
severitystringFilter by severity (critical, warning, info)
servicestringFilter by service

Response

json
{
  "data": [
    {
      "id": "alt_abc123",
      "name": "High CPU Usage",
      "status": "firing",
      "severity": "warning",
      "service": "api-gateway",
      "message": "CPU usage is 92%",
      "started_at": "2025-01-15T10:00:00Z"
    }
  ]
}

Get Alert

http
GET /api/v1/alerts/:id

Acknowledge Alert

http
POST /api/v1/alerts/:id/acknowledge
json
{
  "comment": "Investigating the issue"
}

Resolve Alert

http
POST /api/v1/alerts/:id/resolve

List Alert Rules

http
GET /api/v1/alert-rules

Create Alert Rule

http
POST /api/v1/alert-rules

Request Body

json
{
  "name": "High CPU Alert",
  "condition": "cpu_percent > 80",
  "duration": "5m",
  "severity": "warning",
  "services": ["api-gateway", "auth-service"],
  "notifications": ["slack", "email"]
}

Silence Alerts

http
POST /api/v1/alerts/silence
json
{
  "matcher": {
    "service": "api-gateway"
  },
  "duration": "2h",
  "reason": "Planned maintenance"
}

Released under the MIT License.