List Notification policies

client.alerting.policies.list(, ?): SinglePage<Policy { id, alert_interval, alert_type, 7 more } >

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

Get a list of all Notification policies.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zero Trust: PII ReadNotifications WriteNotifications ReadAccount Settings WriteAccount Settings Read

ParametersExpand Collapse

params: PolicyListParams { account_id }

account_id: string

The account id

maxLength32

ReturnsExpand Collapse

Policy { id, alert_interval, alert_type, 7 more }

id?: string

The unique identifier of a notification policy

maxLength32

alert_interval?: string

Optional specification of how often to re-alert from the same incident, not support on all alert types.

alert_type?: "abuse_report_alert" | "access_custom_certificate_expiration_type" | "advanced_ddos_attack_l4_alert" | 66 more

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.

One of the following:

"abuse_report_alert"

"access_custom_certificate_expiration_type"

"advanced_ddos_attack_l4_alert"

"advanced_ddos_attack_l7_alert"

"advanced_http_alert_error"

"bgp_hijack_notification"

"billing_usage_alert"

"block_notification_block_removed"

"block_notification_new_block"

"block_notification_review_rejected"

"bot_traffic_basic_alert"

"brand_protection_alert"

"brand_protection_digest"

"clickhouse_alert_fw_anomaly"

"clickhouse_alert_fw_ent_anomaly"

"cloudforce_one_request_notification"

"cni_maintenance_notification"

"custom_analytics"

"custom_bot_detection_alert"

"custom_ssl_certificate_event_type"

"dedicated_ssl_certificate_event_type"

"device_connectivity_anomaly_alert"

"dos_attack_l4"

"dos_attack_l7"

"expiring_service_token_alert"

"failing_logpush_job_disabled_alert"

"fbm_auto_advertisement"

"fbm_dosd_attack"

"fbm_volumetric_attack"

"health_check_status_notification"

"hostname_aop_custom_certificate_expiration_type"

"http_alert_edge_error"

"http_alert_origin_error"

"image_notification"

"image_resizing_notification"

"incident_alert"

"load_balancing_health_alert"

"load_balancing_pool_enablement_alert"

"logo_match_alert"

"magic_tunnel_health_check_event"

"magic_wan_tunnel_health"

"maintenance_event_notification"

"mtls_certificate_store_certificate_expiration_type"

"pages_event_alert"

"radar_notification"

"real_origin_monitoring"

"scriptmonitor_alert_new_code_change_detections"

"scriptmonitor_alert_new_hosts"

"scriptmonitor_alert_new_malicious_hosts"

"scriptmonitor_alert_new_malicious_scripts"

"scriptmonitor_alert_new_malicious_url"

"scriptmonitor_alert_new_max_length_resource_url"

"scriptmonitor_alert_new_resources"

"secondary_dns_all_primaries_failing"

"secondary_dns_primaries_failing"

"secondary_dns_warning"

"secondary_dns_zone_successfully_updated"

"secondary_dns_zone_validation_warning"

"security_insights_alert"

"sentinel_alert"

"stream_live_notifications"

"synthetic_test_latency_alert"

"synthetic_test_low_availability_alert"

"traffic_anomalies_alert"

"tunnel_health_event"

"tunnel_update_event"

"universal_ssl_event_type"

"web_analytics_metrics_update"

"zone_aop_custom_certificate_expiration_type"

created?: string

formatdate-time

description?: string

Optional description for the Notification policy.

enabled?: boolean

Whether or not the Notification policy is enabled.

filters?: PolicyFilter { actions, affected_asns, affected_components, 40 more }

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.

actions?: Array<string>

Usage depends on specific alert type

affected_asns?: Array<string>

Used for configuring radar_notification

affected_components?: Array<string>

Used for configuring incident_alert

affected_locations?: Array<string>

Used for configuring radar_notification

airport_code?: Array<string>

Used for configuring maintenance_event_notification

alert_trigger_preferences?: Array<string>

Usage depends on specific alert type

alert_trigger_preferences_value?: Array<string>

Usage depends on specific alert type

enabled?: Array<string>

Used for configuring load_balancing_pool_enablement_alert

environment?: Array<string>

Used for configuring pages_event_alert

event?: Array<string>

Used for configuring pages_event_alert

event_source?: Array<string>

Used for configuring load_balancing_health_alert

event_type?: Array<string>

Usage depends on specific alert type

group_by?: Array<string>

Usage depends on specific alert type

health_check_id?: Array<string>

Used for configuring health_check_status_notification

incident_impact?: Array<"INCIDENT_IMPACT_NONE" | "INCIDENT_IMPACT_MINOR" | "INCIDENT_IMPACT_MAJOR" | "INCIDENT_IMPACT_CRITICAL">

Used for configuring incident_alert

One of the following:

"INCIDENT_IMPACT_NONE"

"INCIDENT_IMPACT_MINOR"

"INCIDENT_IMPACT_MAJOR"

"INCIDENT_IMPACT_CRITICAL"

input_id?: Array<string>

Used for configuring stream_live_notifications

insight_class?: Array<string>

Used for configuring security_insights_alert

limit?: Array<string>

Used for configuring billing_usage_alert

logo_tag?: Array<string>

Used for configuring logo_match_alert

megabits_per_second?: Array<string>

Used for configuring advanced_ddos_attack_l4_alert

new_health?: Array<string>

Used for configuring load_balancing_health_alert

new_status?: Array<string>

Used for configuring tunnel_health_event

packets_per_second?: Array<string>

Used for configuring advanced_ddos_attack_l4_alert

pool_id?: Array<string>

Usage depends on specific alert type

pop_names?: Array<string>

Usage depends on specific alert type

product?: Array<string>

Used for configuring billing_usage_alert

project_id?: Array<string>

Used for configuring pages_event_alert

protocol?: Array<string>

Used for configuring advanced_ddos_attack_l4_alert

query_tag?: Array<string>

Usage depends on specific alert type

requests_per_second?: Array<string>

Used for configuring advanced_ddos_attack_l7_alert

selectors?: Array<string>

Usage depends on specific alert type

services?: Array<string>

Used for configuring clickhouse_alert_fw_ent_anomaly

slo?: Array<string>

Usage depends on specific alert type

status?: Array<string>

Used for configuring health_check_status_notification

target_hostname?: Array<string>

Used for configuring advanced_ddos_attack_l7_alert

target_ip?: Array<string>

Used for configuring advanced_ddos_attack_l4_alert

target_zone_name?: Array<string>

Used for configuring advanced_ddos_attack_l7_alert

traffic_exclusions?: Array<"security_events">

Used for configuring traffic_anomalies_alert

tunnel_id?: Array<string>

Used for configuring tunnel_health_event

tunnel_name?: Array<string>

Usage depends on specific alert type

type?: Array<string>

Usage depends on specific alert type

where?: Array<string>

Usage depends on specific alert type

zones?: Array<string>

Usage depends on specific alert type

mechanisms?: Mechanism { email, pagerduty, webhooks }

List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.

email?: Array<Email>

id?: string

The email address

pagerduty?: Array<Pagerduty>

id?: string

UUID

maxLength32

webhooks?: Array<Webhook>

id?: string

UUID

maxLength32

modified?: string

formatdate-time

name?: string

Name of the policy.

List Notification policies

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const policy of client.alerting.policies.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(policy.id);
}

{
  "errors": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "success": true,
  "result": [
    {
      "id": "0da2b59ef118439d8097bdfb215203c9",
      "alert_interval": "30m",
      "alert_type": "universal_ssl_event_type",
      "created": "2014-01-01T05:20:00.12345Z",
      "description": "Something describing the policy.",
      "enabled": true,
      "filters": {
        "actions": [
          "string"
        ],
        "affected_asns": [
          "string"
        ],
        "affected_components": [
          "string"
        ],
        "affected_locations": [
          "string"
        ],
        "airport_code": [
          "string"
        ],
        "alert_trigger_preferences": [
          "string"
        ],
        "alert_trigger_preferences_value": [
          "string"
        ],
        "enabled": [
          "string"
        ],
        "environment": [
          "string"
        ],
        "event": [
          "string"
        ],
        "event_source": [
          "string"
        ],
        "event_type": [
          "string"
        ],
        "group_by": [
          "string"
        ],
        "health_check_id": [
          "string"
        ],
        "incident_impact": [
          "INCIDENT_IMPACT_NONE"
        ],
        "input_id": [
          "string"
        ],
        "insight_class": [
          "string"
        ],
        "limit": [
          "string"
        ],
        "logo_tag": [
          "string"
        ],
        "megabits_per_second": [
          "string"
        ],
        "new_health": [
          "string"
        ],
        "new_status": [
          "string"
        ],
        "packets_per_second": [
          "string"
        ],
        "pool_id": [
          "string"
        ],
        "pop_names": [
          "string"
        ],
        "product": [
          "string"
        ],
        "project_id": [
          "string"
        ],
        "protocol": [
          "string"
        ],
        "query_tag": [
          "string"
        ],
        "requests_per_second": [
          "string"
        ],
        "selectors": [
          "string"
        ],
        "services": [
          "string"
        ],
        "slo": [
          "99.9"
        ],
        "status": [
          "string"
        ],
        "target_hostname": [
          "string"
        ],
        "target_ip": [
          "string"
        ],
        "target_zone_name": [
          "string"
        ],
        "traffic_exclusions": [
          "security_events"
        ],
        "tunnel_id": [
          "string"
        ],
        "tunnel_name": [
          "string"
        ],
        "type": [
          "string"
        ],
        "where": [
          "string"
        ],
        "zones": [
          "string"
        ]
      },
      "mechanisms": {
        "email": [
          {
            "id": "id"
          }
        ],
        "pagerduty": [
          {
            "id": "f174e90afafe4643bbbc4a0ed4fc8415"
          }
        ],
        "webhooks": [
          {
            "id": "f174e90afafe4643bbbc4a0ed4fc8415"
          }
        ]
      },
      "modified": "2014-01-01T05:20:00.12345Z",
      "name": "SSL Notification Event Policy"
    }
  ]
}

Returns Examples

{
  "errors": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "success": true,
  "result": [
    {
      "id": "0da2b59ef118439d8097bdfb215203c9",
      "alert_interval": "30m",
      "alert_type": "universal_ssl_event_type",
      "created": "2014-01-01T05:20:00.12345Z",
      "description": "Something describing the policy.",
      "enabled": true,
      "filters": {
        "actions": [
          "string"
        ],
        "affected_asns": [
          "string"
        ],
        "affected_components": [
          "string"
        ],
        "affected_locations": [
          "string"
        ],
        "airport_code": [
          "string"
        ],
        "alert_trigger_preferences": [
          "string"
        ],
        "alert_trigger_preferences_value": [
          "string"
        ],
        "enabled": [
          "string"
        ],
        "environment": [
          "string"
        ],
        "event": [
          "string"
        ],
        "event_source": [
          "string"
        ],
        "event_type": [
          "string"
        ],
        "group_by": [
          "string"
        ],
        "health_check_id": [
          "string"
        ],
        "incident_impact": [
          "INCIDENT_IMPACT_NONE"
        ],
        "input_id": [
          "string"
        ],
        "insight_class": [
          "string"
        ],
        "limit": [
          "string"
        ],
        "logo_tag": [
          "string"
        ],
        "megabits_per_second": [
          "string"
        ],
        "new_health": [
          "string"
        ],
        "new_status": [
          "string"
        ],
        "packets_per_second": [
          "string"
        ],
        "pool_id": [
          "string"
        ],
        "pop_names": [
          "string"
        ],
        "product": [
          "string"
        ],
        "project_id": [
          "string"
        ],
        "protocol": [
          "string"
        ],
        "query_tag": [
          "string"
        ],
        "requests_per_second": [
          "string"
        ],
        "selectors": [
          "string"
        ],
        "services": [
          "string"
        ],
        "slo": [
          "99.9"
        ],
        "status": [
          "string"
        ],
        "target_hostname": [
          "string"
        ],
        "target_ip": [
          "string"
        ],
        "target_zone_name": [
          "string"
        ],
        "traffic_exclusions": [
          "security_events"
        ],
        "tunnel_id": [
          "string"
        ],
        "tunnel_name": [
          "string"
        ],
        "type": [
          "string"
        ],
        "where": [
          "string"
        ],
        "zones": [
          "string"
        ]
      },
      "mechanisms": {
        "email": [
          {
            "id": "id"
          }
        ],
        "pagerduty": [
          {
            "id": "f174e90afafe4643bbbc4a0ed4fc8415"
          }
        ],
        "webhooks": [
          {
            "id": "f174e90afafe4643bbbc4a0ed4fc8415"
          }
        ]
      },
      "modified": "2014-01-01T05:20:00.12345Z",
      "name": "SSL Notification Event Policy"
    }
  ]
}