Alert Groups API
Grouped alert management. This page lists all 6 endpoints in the Alert Groups area of the Visual Sentinel REST API.
Base URL: https://visualsentinel.com. Unless an endpoint says otherwise it accepts an API key or a session cookie, see Authentication. Most error responses use the ErrorResponse shape, see Errors and Rate limits.
Endpoints
- List alert groups:
GET /api/alert-groups - Get alert group:
GET /api/alert-groups/{id} - Get alerts in group:
GET /api/alert-groups/{id}/alerts - Acknowledge alert group:
POST /api/alert-groups/{id}/acknowledge - Resolve alert group:
POST /api/alert-groups/{id}/resolve - Summarize alert group:
POST /api/alert-groups/{id}/summarize
List alert groups
GET /api/alert-groups
Get all alert groups for the organization.
Responses
200: List of alert groups.
Get alert group
GET /api/alert-groups/{id}
Get details of a specific alert group.
Parameters
id(path, string (uuid), required)
Responses
200: Alert group details.
Get alerts in group
GET /api/alert-groups/{id}/alerts
Get all alerts belonging to a specific alert group.
Parameters
id(path, string (uuid), required)
Responses
200: Alerts in the group.
Acknowledge alert group
POST /api/alert-groups/{id}/acknowledge
Acknowledge all alerts in a group.
Parameters
id(path, string (uuid), required)
Responses
200: Alert group acknowledged.
Resolve alert group
POST /api/alert-groups/{id}/resolve
Resolve all alerts in a group.
Parameters
id(path, string (uuid), required)
Responses
200: Alert group resolved.
Summarize alert group
POST /api/alert-groups/{id}/summarize
Generate an AI summary of the alert group.
Authentication: session cookie only. API keys are refused.
Parameters
id(path, string (uuid), required)
Responses
200: AI-generated summary.
Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json, the same file the interactive reference reads.