Alert data model
The Alert shape in the Visual Sentinel REST API.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | An alert-rule alert's id, or a source-prefixed id (incident_down_, incident_recovery_, server_alert_, notification_) for history entries. |
type | string | No | |
state | string | No | One of: OPEN, ACKNOWLEDGED, RESOLVED. |
severity | string | No | One of: INFO, WARNING, CRITICAL. |
message | string | No | |
monitorId | string (uuid) | No | |
acknowledgedAt | string (date-time) | No | |
resolvedAt | string (date-time) | No | |
createdAt | string (date-time) | No | |
source | string | No | One of: alert, incident, incident_recovery, server, notification. |
canAcknowledge | boolean | No | POST /api/alerts/{id}/acknowledge applies (an open alert-rule alert). |
canResolve | boolean | No | POST /api/alerts/{id}/resolve applies (an alert-rule alert not yet resolved). |
Used by
- Acknowledge alert:
POST /api/alerts/{id}/acknowledge - Resolve alert:
POST /api/alerts/{id}/resolve - AlertListResponse data model
Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.