--- title: List Notification policies --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Alerting](https://developers.cloudflare.com/api/go/resources/alerting) [Policies](https://developers.cloudflare.com/api/go/resources/alerting/subresources/policies) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Notification policies client.Alerting.Policies.List(ctx, query) (\*SinglePage\[[Policy]()], error) 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 Read``Notifications Write``Notifications Read``Account Settings Write``Account Settings Read` ##### ParametersExpand Collapse
query PolicyListParams AccountID param.Field\[string] The account id maxLength32 Link to this property
[Link to this property](<#(resource)%20alerting.policies%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Policy struct{…} ID stringOptional The unique identifier of a notification policy maxLength32 Link to this property AlertInterval stringOptional Optional specification of how often to re-alert from the same incident, not support on all alert types. Link to this property
AlertType PolicyAlertTypeOptional 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: const PolicyAlertTypeAbuseReportAlert PolicyAlertType = "abuse\_report\_alert" Link to this property const PolicyAlertTypeAccessCustomCertificateExpirationType PolicyAlertType = "access\_custom\_certificate\_expiration\_type" Link to this property const PolicyAlertTypeAdvancedDDoSAttackL4Alert PolicyAlertType = "advanced\_ddos\_attack\_l4\_alert" Link to this property const PolicyAlertTypeAdvancedDDoSAttackL7Alert PolicyAlertType = "advanced\_ddos\_attack\_l7\_alert" Link to this property const PolicyAlertTypeAdvancedHTTPAlertError PolicyAlertType = "advanced\_http\_alert\_error" Link to this property const PolicyAlertTypeBGPHijackNotification PolicyAlertType = "bgp\_hijack\_notification" Link to this property const PolicyAlertTypeBillingUsageAlert PolicyAlertType = "billing\_usage\_alert" Link to this property const PolicyAlertTypeBlockNotificationBlockRemoved PolicyAlertType = "block\_notification\_block\_removed" Link to this property const PolicyAlertTypeBlockNotificationNewBlock PolicyAlertType = "block\_notification\_new\_block" Link to this property const PolicyAlertTypeBlockNotificationReviewRejected PolicyAlertType = "block\_notification\_review\_rejected" Link to this property const PolicyAlertTypeBotTrafficBasicAlert PolicyAlertType = "bot\_traffic\_basic\_alert" Link to this property const PolicyAlertTypeBrandProtectionAlert PolicyAlertType = "brand\_protection\_alert" Link to this property const PolicyAlertTypeBrandProtectionDigest PolicyAlertType = "brand\_protection\_digest" Link to this property const PolicyAlertTypeClickhouseAlertFwAnomaly PolicyAlertType = "clickhouse\_alert\_fw\_anomaly" Link to this property const PolicyAlertTypeClickhouseAlertFwEntAnomaly PolicyAlertType = "clickhouse\_alert\_fw\_ent\_anomaly" Link to this property const PolicyAlertTypeCloudforceOneRequestNotification PolicyAlertType = "cloudforce\_one\_request\_notification" Link to this property const PolicyAlertTypeCNIMaintenanceNotification PolicyAlertType = "cni\_maintenance\_notification" Link to this property const PolicyAlertTypeCustomAnalytics PolicyAlertType = "custom\_analytics" Link to this property const PolicyAlertTypeCustomBotDetectionAlert PolicyAlertType = "custom\_bot\_detection\_alert" Link to this property const PolicyAlertTypeCustomSSLCertificateEventType PolicyAlertType = "custom\_ssl\_certificate\_event\_type" Link to this property const PolicyAlertTypeDedicatedSSLCertificateEventType PolicyAlertType = "dedicated\_ssl\_certificate\_event\_type" Link to this property const PolicyAlertTypeDeviceConnectivityAnomalyAlert PolicyAlertType = "device\_connectivity\_anomaly\_alert" Link to this property const PolicyAlertTypeDosAttackL4 PolicyAlertType = "dos\_attack\_l4" Link to this property const PolicyAlertTypeDosAttackL7 PolicyAlertType = "dos\_attack\_l7" Link to this property const PolicyAlertTypeExpiringServiceTokenAlert PolicyAlertType = "expiring\_service\_token\_alert" Link to this property const PolicyAlertTypeFailingLogpushJobDisabledAlert PolicyAlertType = "failing\_logpush\_job\_disabled\_alert" Link to this property const PolicyAlertTypeFbmAutoAdvertisement PolicyAlertType = "fbm\_auto\_advertisement" Link to this property const PolicyAlertTypeFbmDosdAttack PolicyAlertType = "fbm\_dosd\_attack" Link to this property const PolicyAlertTypeFbmVolumetricAttack PolicyAlertType = "fbm\_volumetric\_attack" Link to this property const PolicyAlertTypeHealthCheckStatusNotification PolicyAlertType = "health\_check\_status\_notification" Link to this property const PolicyAlertTypeHostnameAopCustomCertificateExpirationType PolicyAlertType = "hostname\_aop\_custom\_certificate\_expiration\_type" Link to this property const PolicyAlertTypeHTTPAlertEdgeError PolicyAlertType = "http\_alert\_edge\_error" Link to this property const PolicyAlertTypeHTTPAlertOriginError PolicyAlertType = "http\_alert\_origin\_error" Link to this property const PolicyAlertTypeImageNotification PolicyAlertType = "image\_notification" Link to this property const PolicyAlertTypeImageResizingNotification PolicyAlertType = "image\_resizing\_notification" Link to this property const PolicyAlertTypeIncidentAlert PolicyAlertType = "incident\_alert" Link to this property const PolicyAlertTypeLoadBalancingHealthAlert PolicyAlertType = "load\_balancing\_health\_alert" Link to this property const PolicyAlertTypeLoadBalancingPoolEnablementAlert PolicyAlertType = "load\_balancing\_pool\_enablement\_alert" Link to this property const PolicyAlertTypeLogoMatchAlert PolicyAlertType = "logo\_match\_alert" Link to this property const PolicyAlertTypeMagicTunnelHealthCheckEvent PolicyAlertType = "magic\_tunnel\_health\_check\_event" Link to this property const PolicyAlertTypeMagicWANTunnelHealth PolicyAlertType = "magic\_wan\_tunnel\_health" Link to this property const PolicyAlertTypeMaintenanceEventNotification PolicyAlertType = "maintenance\_event\_notification" Link to this property const PolicyAlertTypeMTLSCertificateStoreCertificateExpirationType PolicyAlertType = "mtls\_certificate\_store\_certificate\_expiration\_type" Link to this property const PolicyAlertTypePagesEventAlert PolicyAlertType = "pages\_event\_alert" Link to this property const PolicyAlertTypeRadarNotification PolicyAlertType = "radar\_notification" Link to this property const PolicyAlertTypeRealOriginMonitoring PolicyAlertType = "real\_origin\_monitoring" Link to this property const PolicyAlertTypeScriptmonitorAlertNewCodeChangeDetections PolicyAlertType = "scriptmonitor\_alert\_new\_code\_change\_detections" Link to this property const PolicyAlertTypeScriptmonitorAlertNewHosts PolicyAlertType = "scriptmonitor\_alert\_new\_hosts" Link to this property const PolicyAlertTypeScriptmonitorAlertNewMaliciousHosts PolicyAlertType = "scriptmonitor\_alert\_new\_malicious\_hosts" Link to this property const PolicyAlertTypeScriptmonitorAlertNewMaliciousScripts PolicyAlertType = "scriptmonitor\_alert\_new\_malicious\_scripts" Link to this property const PolicyAlertTypeScriptmonitorAlertNewMaliciousURL PolicyAlertType = "scriptmonitor\_alert\_new\_malicious\_url" Link to this property const PolicyAlertTypeScriptmonitorAlertNewMaxLengthResourceURL PolicyAlertType = "scriptmonitor\_alert\_new\_max\_length\_resource\_url" Link to this property const PolicyAlertTypeScriptmonitorAlertNewResources PolicyAlertType = "scriptmonitor\_alert\_new\_resources" Link to this property const PolicyAlertTypeSecondaryDNSAllPrimariesFailing PolicyAlertType = "secondary\_dns\_all\_primaries\_failing" Link to this property const PolicyAlertTypeSecondaryDNSPrimariesFailing PolicyAlertType = "secondary\_dns\_primaries\_failing" Link to this property const PolicyAlertTypeSecondaryDNSWarning PolicyAlertType = "secondary\_dns\_warning" Link to this property const PolicyAlertTypeSecondaryDNSZoneSuccessfullyUpdated PolicyAlertType = "secondary\_dns\_zone\_successfully\_updated" Link to this property const PolicyAlertTypeSecondaryDNSZoneValidationWarning PolicyAlertType = "secondary\_dns\_zone\_validation\_warning" Link to this property const PolicyAlertTypeSecurityInsightsAlert PolicyAlertType = "security\_insights\_alert" Link to this property const PolicyAlertTypeSentinelAlert PolicyAlertType = "sentinel\_alert" Link to this property const PolicyAlertTypeStreamLiveNotifications PolicyAlertType = "stream\_live\_notifications" Link to this property const PolicyAlertTypeSyntheticTestLatencyAlert PolicyAlertType = "synthetic\_test\_latency\_alert" Link to this property const PolicyAlertTypeSyntheticTestLowAvailabilityAlert PolicyAlertType = "synthetic\_test\_low\_availability\_alert" Link to this property const PolicyAlertTypeTrafficAnomaliesAlert PolicyAlertType = "traffic\_anomalies\_alert" Link to this property const PolicyAlertTypeTunnelHealthEvent PolicyAlertType = "tunnel\_health\_event" Link to this property const PolicyAlertTypeTunnelUpdateEvent PolicyAlertType = "tunnel\_update\_event" Link to this property const PolicyAlertTypeUniversalSSLEventType PolicyAlertType = "universal\_ssl\_event\_type" Link to this property const PolicyAlertTypeWebAnalyticsMetricsUpdate PolicyAlertType = "web\_analytics\_metrics\_update" Link to this property const PolicyAlertTypeZoneAopCustomCertificateExpirationType PolicyAlertType = "zone\_aop\_custom\_certificate\_expiration\_type" Link to this property
Link to this property Created TimeOptional formatdate-time Link to this property Description stringOptional Optional description for the Notification policy. Link to this property Enabled boolOptional Whether or not the Notification policy is enabled. Link to this property
Filters PolicyFilterOptional 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 \[]stringOptional Usage depends on specific alert type Link to this property AffectedASNs \[]stringOptional Used for configuring radar\_notification Link to this property AffectedComponents \[]stringOptional Used for configuring incident\_alert Link to this property AffectedLocations \[]stringOptional Used for configuring radar\_notification Link to this property AirportCode \[]stringOptional Used for configuring maintenance\_event\_notification Link to this property AlertTriggerPreferences \[]stringOptional Usage depends on specific alert type Link to this property AlertTriggerPreferencesValue \[]stringOptional Usage depends on specific alert type Link to this property Enabled \[]stringOptional Used for configuring load\_balancing\_pool\_enablement\_alert Link to this property Environment \[]stringOptional Used for configuring pages\_event\_alert Link to this property Event \[]stringOptional Used for configuring pages\_event\_alert Link to this property EventSource \[]stringOptional Used for configuring load\_balancing\_health\_alert Link to this property EventType \[]stringOptional Usage depends on specific alert type Link to this property GroupBy \[]stringOptional Usage depends on specific alert type Link to this property HealthCheckID \[]stringOptional Used for configuring health\_check\_status\_notification Link to this property
IncidentImpact \[]PolicyFilterIncidentImpactOptional Used for configuring incident\_alert One of the following: const PolicyFilterIncidentImpactIncidentImpactNone PolicyFilterIncidentImpact = "INCIDENT\_IMPACT\_NONE" Link to this property const PolicyFilterIncidentImpactIncidentImpactMinor PolicyFilterIncidentImpact = "INCIDENT\_IMPACT\_MINOR" Link to this property const PolicyFilterIncidentImpactIncidentImpactMajor PolicyFilterIncidentImpact = "INCIDENT\_IMPACT\_MAJOR" Link to this property const PolicyFilterIncidentImpactIncidentImpactCritical PolicyFilterIncidentImpact = "INCIDENT\_IMPACT\_CRITICAL" Link to this property
Link to this property InputID \[]stringOptional Used for configuring stream\_live\_notifications Link to this property InsightClass \[]stringOptional Used for configuring security\_insights\_alert Link to this property Limit \[]stringOptional Used for configuring billing\_usage\_alert Link to this property LogoTag \[]stringOptional Used for configuring logo\_match\_alert Link to this property MegabitsPerSecond \[]stringOptional Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property NewHealth \[]stringOptional Used for configuring load\_balancing\_health\_alert Link to this property NewStatus \[]stringOptional Used for configuring tunnel\_health\_event Link to this property PacketsPerSecond \[]stringOptional Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property PoolID \[]stringOptional Usage depends on specific alert type Link to this property POPNames \[]stringOptional Usage depends on specific alert type Link to this property Product \[]stringOptional Used for configuring billing\_usage\_alert Link to this property ProjectID \[]stringOptional Used for configuring pages\_event\_alert Link to this property Protocol \[]stringOptional Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property QueryTag \[]stringOptional Usage depends on specific alert type Link to this property RequestsPerSecond \[]stringOptional Used for configuring advanced\_ddos\_attack\_l7\_alert Link to this property Selectors \[]stringOptional Usage depends on specific alert type Link to this property Services \[]stringOptional Used for configuring clickhouse\_alert\_fw\_ent\_anomaly Link to this property Slo \[]stringOptional Usage depends on specific alert type Link to this property Status \[]stringOptional Used for configuring health\_check\_status\_notification Link to this property TargetHostname \[]stringOptional Used for configuring advanced\_ddos\_attack\_l7\_alert Link to this property TargetIP \[]stringOptional Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property TargetZoneName \[]stringOptional Used for configuring advanced\_ddos\_attack\_l7\_alert Link to this property TokenID \[]stringOptional Access service token IDs to include for expiring\_service\_token\_alert. Omit this property to include all current and future service tokens. Link to this property TrafficExclusions \[]PolicyFilterTrafficExclusionOptional Used for configuring traffic\_anomalies\_alert Link to this property TunnelID \[]stringOptional Used for configuring tunnel\_health\_event Link to this property TunnelName \[]stringOptional Usage depends on specific alert type Link to this property Type \[]stringOptional Usage depends on specific alert type Link to this property Where \[]stringOptional Usage depends on specific alert type Link to this property Zones \[]stringOptional Usage depends on specific alert type Link to this property
Link to this property
Mechanisms MechanismOptional List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
Email \[]MechanismEmailOptional ID stringOptional The email address Link to this property
Link to this property
Pagerduty \[]MechanismPagerdutyOptional ID stringOptional UUID maxLength32 Link to this property
Link to this property
Webhooks \[]MechanismWebhookOptional ID stringOptional UUID maxLength32 Link to this property
Link to this property
Link to this property Modified TimeOptional formatdate-time Link to this property Name stringOptional Name of the policy. Link to this property
[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20policy%20%3E%20(schema)>) ### List Notification policies Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/alerting" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Alerting.Policies.List(context.TODO(), alerting.PolicyListParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 200 example ``` { "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" ], "token_id": [ "x" ], "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 200 example ``` { "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" ], "token_id": [ "x" ], "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" } ] } ```