The Alerting service delivers high-level email warnings about resource states (currently certificate expiration and key pair expiration). Administrators should immediately attend to these alerts to avoid a service disruption. By default, each alert is sent only once. The Alerting service filters duplications so that administrators do not receive duplicate alerts.

For administrators to receive these alerts, you must configure a set of alert channels per environment. An alert channel is an alert delivery preference. Currently, only email is supported. Use the alertChannels endpoint to set these preferences, update these preferences, and delete these preferences.

Alert Channel Data Model

Property Type Description
id string Unique ID of the alert channel.
environment object The environment the alert channel belongs to. You can have multiple alert channels per environment.
environment.id string Unique ID of the environment.
channelType string Alert channel type enumeration. Possible values are EMAIL.
addresses array of strings The email addresses to send the alert to.
includeSeverities array of strings Filters alerts by severity. If empty, all severities are included. Possible values are INFO, WARNING, and ERROR.
includeAlertTypes array of strings Filters alerts by alert type. If empty, all alert types are included. Possible values are CERTIFICATE_EXPIRED, CERTIFICATE_EXPIRING, KEY_PAIR_EXPIRED, and KEY_PAIR_EXPIRING.
excludeAlertTypes array of strings Administrators will not be emailed alerts of these types. If empty, no alert types are excluded. Possible values are CERTIFICATE_EXPIRED, CERTIFICATE_EXPIRING, KEY_PAIR_EXPIRED, and KEY_PAIR_EXPIRING.

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.