Get the notification settings
GET /api/notifications
Needs a Viewer or Admin key.
Replies
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | NotificationPreferences |
Reply fields
| Field | Type | Description |
|---|---|---|
enabled |
boolean | Master switch for notifications. When false, nothing is sent whatever else is set here. Always present. |
alertKinds |
list of SecurityEventKind |
The event types that always notify, whatever their score. Unknown values are dropped and repeats removed when you save. Always present. |
minAnomalyScore |
integer | An event of any type notifies when its anomaly score is at or above this, from 0 to 1000. Default 20. Always present. |
crsHitMinScore |
integer | An extra minimum score for single WAF rule hits, which are the noisiest event type: a rule hit notifies only at or above this score. From 0 to 1000; 0 means no extra minimum, which is the default. Always present. |
kindsVersion |
integer | Bookkeeping: which version of the event-type list these settings were saved against. Send back the value that GET returned; PortWall sets the current value when you save. Always present. |
Change the notification settings
PUT /api/notifications
Needs an Admin key.
Send the whole settings object, as GET returns it, with your changes.
Request body: NotificationPreferences
| Field | Type | Description |
|---|---|---|
enabled |
boolean | Master switch for notifications. When false, nothing is sent whatever else is set here. |
alertKinds |
list of SecurityEventKind |
The event types that always notify, whatever their score. Unknown values are dropped and repeats removed when you save. Required. |
minAnomalyScore |
integer | An event of any type notifies when its anomaly score is at or above this, from 0 to 1000. Default 20. |
crsHitMinScore |
integer | An extra minimum score for single WAF rule hits, which are the noisiest event type: a rule hit notifies only at or above this score. From 0 to 1000; 0 means no extra minimum, which is the default. |
kindsVersion |
integer | Bookkeeping: which version of the event-type list these settings were saved against. Send back the value that GET returned; PortWall sets the current value when you save. |
Replies
| Status | Meaning | Body |
|---|---|---|
| 200 | OK | NotificationPreferences |
Reply fields
| Field | Type | Description |
|---|---|---|
enabled |
boolean | Master switch for notifications. When false, nothing is sent whatever else is set here. Always present. |
alertKinds |
list of SecurityEventKind |
The event types that always notify, whatever their score. Unknown values are dropped and repeats removed when you save. Always present. |
minAnomalyScore |
integer | An event of any type notifies when its anomaly score is at or above this, from 0 to 1000. Default 20. Always present. |
crsHitMinScore |
integer | An extra minimum score for single WAF rule hits, which are the noisiest event type: a rule hit notifies only at or above this score. From 0 to 1000; 0 means no extra minimum, which is the default. Always present. |
kindsVersion |
integer | Bookkeeping: which version of the event-type list these settings were saved against. Send back the value that GET returned; PortWall sets the current value when you save. Always present. |
Updated 2026-10-27Something unclear or missing? Tell us.