Skip to main content

List Alerts

Endpoint

GET /api/v1/admin/alerts

Required Role

  • Super Admin

Query Parameters

ParameterTypeDescription
statusstringFilter: open, acknowledged, resolved
severitystringFilter: info, warning, error, critical
pageintegerPage number

Response

{
  "data": [
    {
      "id": "alert-uuid-001",
      "type": "enterprise_health",
      "severity": "warning",
      "title": "Enterprise ACME: Low Activity",
      "message": "No logins detected in the last 72 hours",
      "enterprise_id": "ent-uuid-001",
      "status": "open",
      "created_at": "2026-01-15T08:00:00Z",
      "acknowledged_at": null,
      "resolved_at": null
    }
  ],
  "pagination": { ... }
}

Acknowledge Alert

Endpoint

PATCH /api/v1/admin/alerts/{alert_id}

Required Role

  • Super Admin

Request Body

{
  "status": "acknowledged",
  "notes": "Investigating - enterprise is on holiday"
}

Response

{
  "data": {
    "id": "alert-uuid-001",
    "status": "acknowledged",
    "acknowledged_at": "2026-01-16T10:00:00Z",
    "acknowledged_by": "admin-user-uuid",
    "notes": "Investigating - enterprise is on holiday"
  },
  "message": "Alert acknowledged"
}

Resolve Alert

Endpoint

PATCH /api/v1/admin/alerts/{alert_id}

Request Body

{
  "status": "resolved",
  "resolution": "Enterprise confirmed - no action needed"
}

Response

{
  "data": {
    "id": "alert-uuid-001",
    "status": "resolved",
    "resolved_at": "2026-01-16T11:00:00Z",
    "resolved_by": "admin-user-uuid",
    "resolution": "Enterprise confirmed - no action needed"
  },
  "message": "Alert resolved"
}

Alert Types

TypeDescriptionSeverity
enterprise_healthEnterprise activity issueswarning
authenticationLogin failures, suspicious activitywarning/error
performanceSlow responses, timeoutswarning
databaseConnection or query issueserror/critical
systemInfrastructure problemscritical