alert.list

List all types of alerts including active/dismissed currently in the system.

Type: object

Call parameters

Type: array
No Additional Items

Return value

Result

Type: array of object

Array of all current alerts in the system.

No Additional Items

Each item of this array must be:

Alert

Type: object
No Additional Properties

uuid Required

Uuid

Type: string

Unique identifier for the alert.

source Required

Source

Type: string

Source component that generated the alert.

klass Required

Klass

Type: string

Alert class identifier for categorization.

args Required

Args

Type: object

Arguments and parameters specific to the alert type.

node Required

Node

Type: string

Node identifier in HA systems or hostname for single-node systems.

key Required

Key

Type: string

Unique key used for alert deduplication and identification.

datetime Required

Datetime

Type: stringFormat: date-time

Timestamp when the alert was first created.

last_occurrence Required

Last Occurrence

Type: stringFormat: date-time

Timestamp of the most recent occurrence of this alert.

dismissed Required

Dismissed

Type: boolean

Whether the alert has been manually dismissed by a user.

mail Required

Mail

Type: object

Email notification configuration and status for this alert.

text Required

Text

Type: string

Human-readable description of the alert.

id Required

Id

Type: string

Alert identifier used for API operations.

level Required

Level

Type: string

Severity level of the alert (INFO, WARNING, ERROR, etc.).

formatted Required

Formatted

Formatted alert message with HTML.

Any of

• Option 1
• Option 2

Type: string

Type: null

one_shot Required

One Shot

Type: boolean

Whether this alert will not be dismissed automatically.

Required roles: ALERT_LIST_READ