Update Alert Channel

PUT {{apiPath}}/environments/{{envID}}/alertChannels/{{alertChannelID}}

The PUT /environments/{{envID}}/alertChannels/{{alertChannelID}} operation updates an alert channel for a specified environment.

Prerequisites

  • See Alerting for important overview information.

For property descriptions, see Alert channel data model.

PropertyTypeRequired?
addressesString[]Required
alertNameStringOptional
channelTypeStringRequired
excludeAlertTypesString[]Optional
includeSeveritiesString[]Optional
includeAlertTypesString[]Optional

Request Body

{"channelType"=>"EMAIL", "alertName"=>"Cert Expired Alert", "includeSeverities"=>["WARNING"], "includeAlertTypes"=>["CERTIFICATE_EXPIRED"], "addresses"=>["tom@example.com"]}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/alertChannels/c0bc4d2e-6d5a-46f1-892b-499e526a633a"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"c0bc4d2e-6d5a-46f1-892b-499e526a633a","alertName":"Cert Expired Alert","includeSeverities":["WARNING"],"includeAlertTypes":["CERTIFICATE_EXPIRED"],"addresses":["tom@example.com"],"channelType":"EMAIL"}