Skip to content

Alert

An Alert represents a notification that requires acknowledgement from an operator or administrator. Alerts surface operational events that need human attention and provide a structured workflow for tracking resolution.

The system can generate alerts internally, through triggers, or manually via the API. Each Alert is keyed by its Uuid (auto-generated at creation time) and carries a Level indicating severity: Error, Warn, Info, or Debug. The Name field provides a short human-readable identifier, while Contents holds the full alert details.

When an alert is created with the same Name as an existing unacknowledged alert, the existing alert is reused and its Count field is incremented rather than creating a duplicate. This deduplication prevents alert storms from flooding the system.

Resolution is tracked through Acknowledged, AcknowledgeTime, and AcknowledgeUser fields. The Params map provides structured, filterable data that can be used for automated processing. Principal records which user or system component created the alert, and Note provides space for operator commentary during investigation.

Field

Field Definition
AcknowledgeTime AcknowledgeTime - time of acknowledgement
AcknowledgeUser AcknowledgeUser - user who acknowledged
Acknowledged Acknowledged - has the alert been acknowledged
Contents Contents is the full information about the alert
Count Count is the number of times this Name has been called uniquely
Level Level of the alert
Range of values: Error, Warn, Info, Debug
Name Name is a short name for this alert. This can contain any reference
information for humans you want associated with the alert.
Note Notes - field for additional information about the Alert
Use this field for notes about what is done with the alert.
Params Params - structure of data elements - filterable
Principal Principal is the creator of the alert.
Time Time of the alert.
swagger:strfmt date-time
Uuid The UUID of the alert.
This is auto-created at Create time, and cannot change afterwards.

read only: true
swagger:strfmt uuid