PUT /accounts/{account_id}/alerting/v3/policies/{policy_id}
Update a Notification policy.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
Name | Type | Required | Description |
---|---|---|---|
policy_id |
String | Yes | |
account_id |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
filters |
Object | No |
Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details. |
filters.insight_class[] |
Array | No |
Used for configuring security_insights_alert |
filters.requests_per_second[] |
Array | No |
Used for configuring advanced_ddos_attack_l7_alert |
filters.target_hostname[] |
Array | No |
Used for configuring advanced_ddos_attack_l7_alert |
filters.protocol[] |
Array | No |
Used for configuring advanced_ddos_attack_l4_alert |
filters.event[] |
Array | No |
Used for configuring pages_event_alert |
filters.query_tag[] |
Array | No |
Usage depends on specific alert type |
filters.alert_trigger_preferences_value[] |
Array | No |
Usage depends on specific alert type |
filters.new_health[] |
Array | No |
Used for configuring load_balancing_health_alert |
filters.airport_code[] |
Array | No |
Used for configuring maintenance_event_notification |
filters.affected_locations[] |
Array | No |
Used for configuring radar_notification |
filters.selectors[] |
Array | No |
Usage depends on specific alert type |
filters.traffic_exclusions[] |
Array | No |
Used for configuring traffic_anomalies_alert |
filters.limit[] |
Array | No |
Used for configuring billing_usage_alert |
filters.tunnel_id[] |
Array | No |
Used for configuring tunnel_health_event |
filters.zones[] |
Array | No |
Usage depends on specific alert type |
filters.event_type[] |
Array | No |
Usage depends on specific alert type |
filters.health_check_id[] |
Array | No |
Used for configuring health_check_status_notification |
filters.new_status[] |
Array | No |
Used for configuring tunnel_health_event |
filters.tunnel_name[] |
Array | No |
Usage depends on specific alert type |
filters.pool_id[] |
Array | No |
Usage depends on specific alert type |
filters.where[] |
Array | No |
Usage depends on specific alert type |
filters.alert_trigger_preferences[] |
Array | No |
Usage depends on specific alert type |
filters.group_by[] |
Array | No |
Usage depends on specific alert type |
filters.project_id[] |
Array | No |
Used for configuring pages_event_alert |
filters.logo_tag[] |
Array | No |
Used for configuring logo_match_alert |
filters.services[] |
Array | No |
Used for configuring clickhouse_alert_fw_ent_anomaly |
filters.target_zone_name[] |
Array | No |
Used for configuring advanced_ddos_attack_l7_alert |
filters.environment[] |
Array | No |
Used for configuring pages_event_alert |
filters.product[] |
Array | No |
Used for configuring billing_usage_alert |
filters.target_ip[] |
Array | No |
Used for configuring advanced_ddos_attack_l4_alert |
filters.pop_names[] |
Array | No |
Usage depends on specific alert type |
filters.slo[] |
Array | No |
Usage depends on specific alert type |
filters.status[] |
Array | No |
Used for configuring health_check_status_notification |
filters.input_id[] |
Array | No |
Used for configuring stream_live_notifications |
filters.incident_impact[] |
Array | No |
Used for configuring incident_alert |
filters.actions[] |
Array | No |
Usage depends on specific alert type |
filters.packets_per_second[] |
Array | No |
Used for configuring advanced_ddos_attack_l4_alert |
filters.megabits_per_second[] |
Array | No |
Used for configuring advanced_ddos_attack_l4_alert |
filters.enabled[] |
Array | No |
Used for configuring load_balancing_pool_enablement_alert |
filters.affected_components[] |
Array | No |
Used for configuring incident_alert |
filters.affected_asns[] |
Array | No |
Used for configuring radar_notification |
filters.event_source[] |
Array | No |
Used for configuring load_balancing_health_alert |
alert_type |
String | No |
Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Possible values:
|
name |
String | No |
Name of the policy. |
description |
String | No |
Optional description for the Notification policy. |
alert_interval |
String | No |
Optional specification of how often to re-alert from the same incident, not support on all alert types. |
mechanisms |
Object | No |
List of IDs that will be used when dispatching a notification. IDs for email type will be the email address. |
mechanisms.email[] |
Array | No | |
mechanisms.email[].id |
String | No |
The email address |
mechanisms.webhooks[] |
Array | No | |
mechanisms.webhooks[].id |
String | No |
UUID |
mechanisms.pagerduty[] |
Array | No | |
mechanisms.pagerduty[].id |
String | No |
UUID |
enabled |
Boolean | No |
Whether or not the Notification policy is enabled. Default value: true |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.