POST /accounts/{account_id}/alerting/v3/policies

Creates a new Notification policy.

Servers

Path parameters

Name Type Required Description
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 Yes

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:

  • "billing_usage_alert"
  • "brand_protection_digest"
  • "dos_attack_l4"
  • "block_notification_review_rejected"
  • "web_analytics_metrics_update"
  • "health_check_status_notification"
  • "scriptmonitor_alert_new_malicious_hosts"
  • "block_notification_block_removed"
  • "failing_logpush_job_disabled_alert"
  • "stream_live_notifications"
  • "image_notification"
  • "scriptmonitor_alert_new_code_change_detections"
  • "tunnel_health_event"
  • "cloudforce_one_request_notification"
  • "mtls_certificate_store_certificate_expiration_type"
  • "load_balancing_pool_enablement_alert"
  • "clickhouse_alert_fw_ent_anomaly"
  • "fbm_volumetric_attack"
  • "magic_tunnel_health_check_event"
  • "hostname_aop_custom_certificate_expiration_type"
  • "pages_event_alert"
  • "image_resizing_notification"
  • "radar_notification"
  • "maintenance_event_notification"
  • "advanced_http_alert_error"
  • "zone_aop_custom_certificate_expiration_type"
  • "scriptmonitor_alert_new_resources"
  • "security_insights_alert"
  • "advanced_ddos_attack_l7_alert"
  • "block_notification_new_block"
  • "expiring_service_token_alert"
  • "access_custom_certificate_expiration_type"
  • "tunnel_update_event"
  • "synthetic_test_low_availability_alert"
  • "clickhouse_alert_fw_anomaly"
  • "secondary_dns_all_primaries_failing"
  • "real_origin_monitoring"
  • "secondary_dns_warning"
  • "traffic_anomalies_alert"
  • "logo_match_alert"
  • "fbm_auto_advertisement"
  • "device_connectivity_anomaly_alert"
  • "secondary_dns_primaries_failing"
  • "custom_analytics"
  • "magic_wan_tunnel_health"
  • "brand_protection_alert"
  • "http_alert_origin_error"
  • "universal_ssl_event_type"
  • "custom_bot_detection_alert"
  • "synthetic_test_latency_alert"
  • "custom_ssl_certificate_event_type"
  • "secondary_dns_zone_validation_warning"
  • "scriptmonitor_alert_new_malicious_url"
  • "dos_attack_l7"
  • "secondary_dns_zone_successfully_updated"
  • "scriptmonitor_alert_new_malicious_scripts"
  • "scriptmonitor_alert_new_max_length_resource_url"
  • "scriptmonitor_alert_new_hosts"
  • "bgp_hijack_notification"
  • "dedicated_ssl_certificate_event_type"
  • "advanced_ddos_attack_l4_alert"
  • "sentinel_alert"
  • "http_alert_edge_error"
  • "fbm_dosd_attack"
  • "load_balancing_health_alert"
  • "incident_alert"
  • "bot_traffic_basic_alert"
name String Yes

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 Yes

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 Yes

Whether or not the Notification policy is enabled.

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.