banshee/storage-collection/storage/truenas/https/api-v2.0/alerts

Alerts of a TrueNAS, by its REST API

Returns the alerts a TrueNAS raises itself and that are still active (a SMART failure, a pool degraded, a certificate expiring, an update available…): for each class of alert, its most severe level and the number of its alerts. One watch is offered, set on the probe.

Versions

Written for the REST API v2.0, which answers on TrueNAS CORE 12 and 13 and on TrueNAS SCALE up to 25.10, and was removed in TrueNAS 26. Hence the folder api-v2.0.

How it works

One GET https://<host:address>/api/v2.0/alert/list, the key in the header Authorization: Bearer. The API answers a list of alerts:

[{"klass": "SMARTFail", "level": "CRITICAL", "dismissed": false, "formatted": "Device: /dev/sdc, …", …}]

An alert an administrator dismissed in TrueNAS is left out.
The instance is the class of the alert (klass); several alerts of one class (two disks failing) make one instance, with the most severe level and their count.
The levels of TrueNAS are, from the least to the most severe, info, notice, warning, error, critical, alert, emergency, returned in lower case.
No alert active returns no value, and raises nothing: the probe stays OK.

The key comes from protocol:http:token, a secret variable: it only goes in the header. The answer is not secret.

Prerequisites

The web interface of TrueNAS reachable from the poller in HTTPS, on port 443 of the host's address, its certificate trusted by the TLS profile of the probe (a pinned fingerprint in protocol:http:fingerprint, or the certificate under protocol:tls:authorities).
An API key in protocol:http:token, of a user of the read-only administrator role where SCALE has roles.

Outputs

Name	Label	Unit	Per instance
`level`	Most severe level	—	yes, per alert class
`count`	Active alerts	—	yes, per alert class

Watches

Name	Title	Kind	Defaults	Checked by default
`raised`	TrueNAS alert	state to avoid, on `level`	warning on `warning`; critical on `error`, `critical`, `alert`, `emergency`	yes

Limits

The text of an alert is not returned: it is read in TrueNAS. The probe says which class raises, and how many.
An alert class that should not raise here is left out by the selection of the probe (Alert classes: All except…).
From TrueNAS 25.10.1, each call to the REST API raises a TrueNAS alert that a deprecated endpoint is used, which this collector then returns: leave its class out of the selection.
Not checked against a TrueNAS: the fields are those of alert.list in the API documentation of TrueNAS 25.10; the levels are those of AlertLevelType in TRUENAS-MIB.