Alerting

The Alerting service delivers warnings to administrators' email addresses regarding changes in resource states that can cause service disruptions. By default, each alert is sent only once. The Alerting service filters out any duplicate alerts.

For administrators to receive these alerts, you must configure the alert channel to use for each environment. Currently, email is the only supported type of alert channel. Use the Alerting service endpoints to configure the alert channel.

Administrators can also configure Alerting preferences in the PingOne admin console.

Alert channel data model

Property Type Required? Mutable? Description

Property	Type	Required?	Mutable?	Description
`addresses`	String[]	Required	Mutable	The administrator email addresses to send the alerts to.
`channelType`	String	Required	Mutable	Alert channel type. Currently, this must be `EMAIL`.
`alertName`	String	Optional	Mutable	The name to assign to the alert channel.
`environment.id`	String	Required	Immutable	Unique ID of the environment.
`excludeAlertTypes`	String[]	Optional	Mutable	Administrators will not be emailed alerts of these types. If empty, no alert types are excluded. Possible values are those listed for `includeAlertTypes`.
`id`	String	N/A	Read-only	Unique ID of the alert channel.
`includeSeverities`	String[]	Optional	Mutable	Filters alerts by severity. If empty, all severities are included. Possible values are `INFO`, `WARNING`, and `ERROR`.
`includeAlertTypes`	String[]	Optional	Mutable	Use the `includeAlertTypes` array to specify the alert types you want to create. If empty, all alert types are included. Possible values are: `CERTIFICATE_EXPIRED`, `CERTIFICATE_EXPIRING`, `GATEWAY_ERROR_ALERT`, `GATEWAY_INFO_ALERT`, `GATEWAY_WARNING_ALERT`, `GATEWAY_VERSION_DEPRECATED`, `GATEWAY_VERSION_DEPRECATING` , `KEY_PAIR_EXPIRED`, `KEY_PAIR_EXPIRING`, `LICENSE_90_PERCENT_USER_SOFT_LIMIT`, `LICENSE_EXPIRED`, `LICENSE_EXPIRING`, `LICENSE_ROTATED`, `LICENSE_USER_HARD_LIMIT_EXCEEDED`, `LICENSE_USER_SOFT_LIMIT_EXCEEDED`, `RATE_LIMIT_EXCEEDED` , `RATE_LIMIT_WARNING`, `RISK_CONFIGURATION`, `SUSPICIOUS_TRAFFIC`.

addresses

String[]

Required

Mutable

The administrator email addresses to send the alerts to.

channelType

String

Required

Mutable

Alert channel type. Currently, this must be EMAIL.

alertName

String

Optional

Mutable

The name to assign to the alert channel.

environment.id

String

Required

Immutable

Unique ID of the environment.

excludeAlertTypes

String[]

Optional

Mutable

Administrators will not be emailed alerts of these types. If empty, no alert types are excluded. Possible values are those listed for includeAlertTypes.

id

String

N/A

Read-only

Unique ID of the alert channel.

includeSeverities

String[]

Optional

Mutable

Filters alerts by severity. If empty, all severities are included. Possible values are INFO, WARNING, and ERROR.

includeAlertTypes

String[]

Optional

Mutable

Use the includeAlertTypes array to specify the alert types you want to create. If empty, all alert types are included. Possible values are: CERTIFICATE_EXPIRED, CERTIFICATE_EXPIRING, GATEWAY_ERROR_ALERT, GATEWAY_INFO_ALERT, GATEWAY_WARNING_ALERT, GATEWAY_VERSION_DEPRECATED, GATEWAY_VERSION_DEPRECATING , KEY_PAIR_EXPIRED, KEY_PAIR_EXPIRING, LICENSE_90_PERCENT_USER_SOFT_LIMIT, LICENSE_EXPIRED, LICENSE_EXPIRING, LICENSE_ROTATED, LICENSE_USER_HARD_LIMIT_EXCEEDED, LICENSE_USER_SOFT_LIMIT_EXCEEDED, RATE_LIMIT_EXCEEDED , RATE_LIMIT_WARNING, RISK_CONFIGURATION, SUSPICIOUS_TRAFFIC.

Alert events generated

Refer to Audit Reporting Events for the events generated.

Response codes

Code	Message
200	Successful operation.
201	Successfully created.
204	Successfully removed. No content.
400	The request could not be completed.
401	You do not have access to this resource.
404	The requested resource was not found.

PingOne Platform APIs

Alerting

Alert channel data model

Alert events generated

Response codes