--- title: Alerting --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Alerting #### AlertingAvailable Alerts ##### [Get Alert Types](https://developers.cloudflare.com/api/resources/alerting/subresources/available_alerts/methods/list) GET/accounts/{account\_id}/alerting/v3/available\_alerts ##### ModelsExpand Collapse

AvailableAlertListResponse = map\[array of object {description, display\_name, filter\_options, type } ]

description: optional string Describes the alert type. Link to this property display\_name: optional string Alert type name. Link to this property filter\_options: optional array of unknown Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings. Link to this property type: optional string Use this value when creating and updating a notification policy. Link to this property

[Link to this property](<#(resource)%20alerting.available_alerts%20%3E%20(model)%20available_alert_list_response%20%3E%20(schema)>) #### AlertingDestinations #### AlertingDestinationsEligible ##### [Get delivery mechanism eligibility](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/eligible/methods/get) GET/accounts/{account\_id}/alerting/v3/destinations/eligible ##### ModelsExpand Collapse

EligibleGetResponse = map\[array of object {eligible, ready, type } ]

eligible: optional boolean Determines whether or not the account is eligible for the delivery mechanism. Link to this property ready: optional boolean Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications. Link to this property

type: optional "email"or "pagerduty"or "webhook" Determines type of delivery mechanism.

One of the following: "email" Link to this property "pagerduty" Link to this property "webhook" Link to this property

Link to this property

[Link to this property](<#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)>) #### AlertingDestinationsPagerduty ##### [List PagerDuty services](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/pagerduty/methods/get) GET/accounts/{account\_id}/alerting/v3/destinations/pagerduty ##### [Create PagerDuty integration token](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/pagerduty/methods/create) POST/accounts/{account\_id}/alerting/v3/destinations/pagerduty/connect ##### [Delete PagerDuty Services](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/pagerduty/methods/delete) DELETE/accounts/{account\_id}/alerting/v3/destinations/pagerduty ##### [Connect PagerDuty](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/pagerduty/methods/link) GET/accounts/{account\_id}/alerting/v3/destinations/pagerduty/connect/{token\_id} ##### ModelsExpand Collapse

Pagerduty object {id, name }

id: optional string UUID maxLength32 Link to this property name: optional string The name of the pagerduty service. Link to this property

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty%20%3E%20(schema)>)

PagerdutyCreateResponse object {id }

id: optional string token in form of UUID maxLength32 Link to this property

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_create_response%20%3E%20(schema)>)

PagerdutyDeleteResponse object {errors, messages, success }

errors: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property

messages: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property success: true Whether the API call was successful Link to this property

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)>)

PagerdutyLinkResponse object {id }

id: optional string UUID maxLength32 Link to this property

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_link_response%20%3E%20(schema)>) #### AlertingDestinationsWebhooks ##### [List webhooks](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/webhooks/methods/list) GET/accounts/{account\_id}/alerting/v3/destinations/webhooks ##### [Get a webhook](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/webhooks/methods/get) GET/accounts/{account\_id}/alerting/v3/destinations/webhooks/{webhook\_id} ##### [Create a webhook](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/webhooks/methods/create) POST/accounts/{account\_id}/alerting/v3/destinations/webhooks ##### [Update a webhook](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/webhooks/methods/update) PUT/accounts/{account\_id}/alerting/v3/destinations/webhooks/{webhook\_id} ##### [Delete a webhook](https://developers.cloudflare.com/api/resources/alerting/subresources/destinations/subresources/webhooks/methods/delete) DELETE/accounts/{account\_id}/alerting/v3/destinations/webhooks/{webhook\_id} ##### ModelsExpand Collapse

Webhooks object {id, created\_at, last\_failure, 5 more }

id: optional string The unique identifier of a webhook maxLength32 Link to this property created\_at: optional string Timestamp of when the webhook destination was created. formatdate-time Link to this property last\_failure: optional string Timestamp of the last time an attempt to dispatch a notification to this webhook failed. formatdate-time Link to this property last\_success: optional string Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook. formatdate-time Link to this property name: optional string The name of the webhook destination. This will be included in the request body when you receive a webhook notification. Link to this property secret: optional string Optional secret that will be passed in the cf-webhook-auth header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body. Link to this property

type: optional "datadog"or "discord"or "feishu"or 5 more Type of webhook endpoint.

One of the following: "datadog" Link to this property "discord" Link to this property "feishu" Link to this property "gchat" Link to this property "generic" Link to this property "opsgenie" Link to this property "slack" Link to this property "splunk" Link to this property

Link to this property url: optional string The POST endpoint to call when dispatching a notification. Link to this property

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)>)

WebhookCreateResponse object {id }

id: optional string UUID maxLength32 Link to this property

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_create_response%20%3E%20(schema)>)

WebhookUpdateResponse object {id }

id: optional string UUID maxLength32 Link to this property

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_update_response%20%3E%20(schema)>)

WebhookDeleteResponse object {errors, messages, success }

errors: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property

messages: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property success: true Whether the API call was successful Link to this property

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)>) #### AlertingHistory ##### [List History](https://developers.cloudflare.com/api/resources/alerting/subresources/history/methods/list) GET/accounts/{account\_id}/alerting/v3/history ##### ModelsExpand Collapse

History object {id, alert\_body, alert\_type, 6 more }

id: optional string UUID maxLength32 Link to this property alert\_body: optional string Message body included in the notification sent. Link to this property alert\_type: optional string Type of notification that has been dispatched. Link to this property description: optional string Description of the notification policy (if present). Link to this property mechanism: optional string The mechanism to which the notification has been dispatched. Link to this property

mechanism\_type: optional "email"or "pagerduty"or "webhook" The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.

One of the following: "email" Link to this property "pagerduty" Link to this property "webhook" Link to this property

Link to this property name: optional string Name of the policy. Link to this property policy\_id: optional string The unique identifier of a notification policy maxLength32 Link to this property sent: optional string Timestamp of when the notification was dispatched in ISO 8601 format. formatdate-time Link to this property

[Link to this property](<#(resource)%20alerting.history%20%3E%20(model)%20history%20%3E%20(schema)>) #### AlertingPolicies ##### [List Notification policies](https://developers.cloudflare.com/api/resources/alerting/subresources/policies/methods/list) GET/accounts/{account\_id}/alerting/v3/policies ##### [Get a Notification policy](https://developers.cloudflare.com/api/resources/alerting/subresources/policies/methods/get) GET/accounts/{account\_id}/alerting/v3/policies/{policy\_id} ##### [Create a Notification policy](https://developers.cloudflare.com/api/resources/alerting/subresources/policies/methods/create) POST/accounts/{account\_id}/alerting/v3/policies ##### [Update a Notification policy](https://developers.cloudflare.com/api/resources/alerting/subresources/policies/methods/update) PUT/accounts/{account\_id}/alerting/v3/policies/{policy\_id} ##### [Delete a Notification policy](https://developers.cloudflare.com/api/resources/alerting/subresources/policies/methods/delete) DELETE/accounts/{account\_id}/alerting/v3/policies/{policy\_id} ##### ModelsExpand Collapse

Mechanism object {email, pagerduty, webhooks } List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.

email: optional array of object {id }

id: optional string The email address Link to this property

Link to this property

pagerduty: optional array of object {id }

id: optional string UUID maxLength32 Link to this property

Link to this property

webhooks: optional array of object {id }

id: optional string UUID maxLength32 Link to this property

Link to this property

[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20mechanism%20%3E%20(schema)>)

Policy object {id, alert\_interval, alert\_type, 7 more }

id: optional string The unique identifier of a notification policy maxLength32 Link to this property alert\_interval: optional string Optional specification of how often to re-alert from the same incident, not support on all alert types. Link to this property

alert\_type: optional "abuse\_report\_alert"or "access\_custom\_certificate\_expiration\_type"or "advanced\_ddos\_attack\_l4\_alert"or 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" Link to this property "access\_custom\_certificate\_expiration\_type" Link to this property "advanced\_ddos\_attack\_l4\_alert" Link to this property "advanced\_ddos\_attack\_l7\_alert" Link to this property "advanced\_http\_alert\_error" Link to this property "bgp\_hijack\_notification" Link to this property "billing\_usage\_alert" Link to this property "block\_notification\_block\_removed" Link to this property "block\_notification\_new\_block" Link to this property "block\_notification\_review\_rejected" Link to this property "bot\_traffic\_basic\_alert" Link to this property "brand\_protection\_alert" Link to this property "brand\_protection\_digest" Link to this property "clickhouse\_alert\_fw\_anomaly" Link to this property "clickhouse\_alert\_fw\_ent\_anomaly" Link to this property "cloudforce\_one\_request\_notification" Link to this property "cni\_maintenance\_notification" Link to this property "custom\_analytics" Link to this property "custom\_bot\_detection\_alert" Link to this property "custom\_ssl\_certificate\_event\_type" Link to this property "dedicated\_ssl\_certificate\_event\_type" Link to this property "device\_connectivity\_anomaly\_alert" Link to this property "dos\_attack\_l4" Link to this property "dos\_attack\_l7" Link to this property "expiring\_service\_token\_alert" Link to this property "failing\_logpush\_job\_disabled\_alert" Link to this property "fbm\_auto\_advertisement" Link to this property "fbm\_dosd\_attack" Link to this property "fbm\_volumetric\_attack" Link to this property "health\_check\_status\_notification" Link to this property "hostname\_aop\_custom\_certificate\_expiration\_type" Link to this property "http\_alert\_edge\_error" Link to this property "http\_alert\_origin\_error" Link to this property "image\_notification" Link to this property "image\_resizing\_notification" Link to this property "incident\_alert" Link to this property "load\_balancing\_health\_alert" Link to this property "load\_balancing\_pool\_enablement\_alert" Link to this property "logo\_match\_alert" Link to this property "magic\_tunnel\_health\_check\_event" Link to this property "magic\_wan\_tunnel\_health" Link to this property "maintenance\_event\_notification" Link to this property "mtls\_certificate\_store\_certificate\_expiration\_type" Link to this property "pages\_event\_alert" Link to this property "radar\_notification" Link to this property "real\_origin\_monitoring" Link to this property "scriptmonitor\_alert\_new\_code\_change\_detections" Link to this property "scriptmonitor\_alert\_new\_hosts" Link to this property "scriptmonitor\_alert\_new\_malicious\_hosts" Link to this property "scriptmonitor\_alert\_new\_malicious\_scripts" Link to this property "scriptmonitor\_alert\_new\_malicious\_url" Link to this property "scriptmonitor\_alert\_new\_max\_length\_resource\_url" Link to this property "scriptmonitor\_alert\_new\_resources" Link to this property "secondary\_dns\_all\_primaries\_failing" Link to this property "secondary\_dns\_primaries\_failing" Link to this property "secondary\_dns\_warning" Link to this property "secondary\_dns\_zone\_successfully\_updated" Link to this property "secondary\_dns\_zone\_validation\_warning" Link to this property "security\_insights\_alert" Link to this property "sentinel\_alert" Link to this property "stream\_live\_notifications" Link to this property "synthetic\_test\_latency\_alert" Link to this property "synthetic\_test\_low\_availability\_alert" Link to this property "traffic\_anomalies\_alert" Link to this property "tunnel\_health\_event" Link to this property "tunnel\_update\_event" Link to this property "universal\_ssl\_event\_type" Link to this property "web\_analytics\_metrics\_update" Link to this property "zone\_aop\_custom\_certificate\_expiration\_type" Link to this property

Link to this property created: optional string formatdate-time Link to this property description: optional string Optional description for the Notification policy. Link to this property enabled: optional boolean Whether or not the Notification policy is enabled. Link to this property filters: optional PolicyFilter { actions, affected\_asns, affected\_components, 41 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. Link to this property mechanisms: optional Mechanism { email, pagerduty, webhooks } List of IDs that will be used when dispatching a notification. IDs for email type will be the email address. Link to this property modified: optional string formatdate-time Link to this property name: optional string Name of the policy. Link to this property

[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20policy%20%3E%20(schema)>)

PolicyFilter object {actions, affected\_asns, affected\_components, 41 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: optional array of string Usage depends on specific alert type Link to this property affected\_asns: optional array of string Used for configuring radar\_notification Link to this property affected\_components: optional array of string Used for configuring incident\_alert Link to this property affected\_locations: optional array of string Used for configuring radar\_notification Link to this property airport\_code: optional array of string Used for configuring maintenance\_event\_notification Link to this property alert\_trigger\_preferences: optional array of string Usage depends on specific alert type Link to this property alert\_trigger\_preferences\_value: optional array of string Usage depends on specific alert type Link to this property enabled: optional array of string Used for configuring load\_balancing\_pool\_enablement\_alert Link to this property environment: optional array of string Used for configuring pages\_event\_alert Link to this property event: optional array of string Used for configuring pages\_event\_alert Link to this property event\_source: optional array of string Used for configuring load\_balancing\_health\_alert Link to this property event\_type: optional array of string Usage depends on specific alert type Link to this property group\_by: optional array of string Usage depends on specific alert type Link to this property health\_check\_id: optional array of string Used for configuring health\_check\_status\_notification Link to this property

incident\_impact: optional array of "INCIDENT\_IMPACT\_NONE"or "INCIDENT\_IMPACT\_MINOR"or "INCIDENT\_IMPACT\_MAJOR"or "INCIDENT\_IMPACT\_CRITICAL" Used for configuring incident\_alert

One of the following: "INCIDENT\_IMPACT\_NONE" Link to this property "INCIDENT\_IMPACT\_MINOR" Link to this property "INCIDENT\_IMPACT\_MAJOR" Link to this property "INCIDENT\_IMPACT\_CRITICAL" Link to this property

Link to this property input\_id: optional array of string Used for configuring stream\_live\_notifications Link to this property insight\_class: optional array of string Used for configuring security\_insights\_alert Link to this property limit: optional array of string Used for configuring billing\_usage\_alert Link to this property logo\_tag: optional array of string Used for configuring logo\_match\_alert Link to this property megabits\_per\_second: optional array of string Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property new\_health: optional array of string Used for configuring load\_balancing\_health\_alert Link to this property new\_status: optional array of string Used for configuring tunnel\_health\_event Link to this property packets\_per\_second: optional array of string Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property pool\_id: optional array of string Usage depends on specific alert type Link to this property pop\_names: optional array of string Usage depends on specific alert type Link to this property product: optional array of string Used for configuring billing\_usage\_alert Link to this property project\_id: optional array of string Used for configuring pages\_event\_alert Link to this property protocol: optional array of string Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property query\_tag: optional array of string Usage depends on specific alert type Link to this property requests\_per\_second: optional array of string Used for configuring advanced\_ddos\_attack\_l7\_alert Link to this property selectors: optional array of string Usage depends on specific alert type Link to this property services: optional array of string Used for configuring clickhouse\_alert\_fw\_ent\_anomaly Link to this property slo: optional array of string Usage depends on specific alert type Link to this property status: optional array of string Used for configuring health\_check\_status\_notification Link to this property target\_hostname: optional array of string Used for configuring advanced\_ddos\_attack\_l7\_alert Link to this property target\_ip: optional array of string Used for configuring advanced\_ddos\_attack\_l4\_alert Link to this property target\_zone\_name: optional array of string Used for configuring advanced\_ddos\_attack\_l7\_alert Link to this property token\_id: optional array of string 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 traffic\_exclusions: optional array of "security\_events" Used for configuring traffic\_anomalies\_alert Link to this property tunnel\_id: optional array of string Used for configuring tunnel\_health\_event Link to this property tunnel\_name: optional array of string Usage depends on specific alert type Link to this property type: optional array of string Usage depends on specific alert type Link to this property where: optional array of string Usage depends on specific alert type Link to this property zones: optional array of string Usage depends on specific alert type Link to this property

[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20policy_filter%20%3E%20(schema)>)

PolicyCreateResponse object {id }

id: optional string UUID maxLength32 Link to this property

[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20policy_create_response%20%3E%20(schema)>)

PolicyUpdateResponse object {id }

id: optional string UUID maxLength32 Link to this property

[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20policy_update_response%20%3E%20(schema)>)

PolicyDeleteResponse object {errors, messages, success, result\_info }

errors: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property

messages: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property success: true Whether the API call was successful Link to this property

result\_info: optional object {count, page, per\_page, total\_count }

count: optional number Total number of results for the requested service Link to this property page: optional number Current page within paginated list of results Link to this property per\_page: optional number Number of results per page of results Link to this property total\_count: optional number Total results available without any search parameters Link to this property

Link to this property

[Link to this property](<#(resource)%20alerting.policies%20%3E%20(model)%20policy_delete_response%20%3E%20(schema)>) #### AlertingSilences ##### [List Silences](https://developers.cloudflare.com/api/resources/alerting/subresources/silences/methods/list) GET/accounts/{account\_id}/alerting/v3/silences ##### [Get Silence](https://developers.cloudflare.com/api/resources/alerting/subresources/silences/methods/get) GET/accounts/{account\_id}/alerting/v3/silences/{silence\_id} ##### [Create Silences](https://developers.cloudflare.com/api/resources/alerting/subresources/silences/methods/create) POST/accounts/{account\_id}/alerting/v3/silences ##### [Update Silences](https://developers.cloudflare.com/api/resources/alerting/subresources/silences/methods/update) PUT/accounts/{account\_id}/alerting/v3/silences ##### [Delete Silence](https://developers.cloudflare.com/api/resources/alerting/subresources/silences/methods/delete) DELETE/accounts/{account\_id}/alerting/v3/silences/{silence\_id} ##### ModelsExpand Collapse

SilenceListResponse object {id, created\_at, end\_time, 3 more }

id: optional string Silence ID maxLength32 Link to this property created\_at: optional string When the silence was created. Link to this property end\_time: optional string When the silence ends. Link to this property policy\_id: optional string The unique identifier of a notification policy maxLength32 Link to this property start\_time: optional string When the silence starts. Link to this property updated\_at: optional string When the silence was modified. Link to this property

[Link to this property](<#(resource)%20alerting.silences%20%3E%20(model)%20silence_list_response%20%3E%20(schema)>)

SilenceGetResponse object {id, created\_at, end\_time, 3 more }

[Link to this property](<#(resource)%20alerting.silences%20%3E%20(model)%20silence_get_response%20%3E%20(schema)>)

SilenceCreateResponse object {errors, messages, success }

errors: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property

messages: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property success: true Whether the API call was successful Link to this property

[Link to this property](<#(resource)%20alerting.silences%20%3E%20(model)%20silence_create_response%20%3E%20(schema)>)

SilenceUpdateResponse object {id, created\_at, end\_time, 3 more }

[Link to this property](<#(resource)%20alerting.silences%20%3E%20(model)%20silence_update_response%20%3E%20(schema)>)

SilenceDeleteResponse object {errors, messages, success }

errors: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property

messages: array of object {message, code }

message: string Link to this property code: optional number minimum1000 Link to this property

Link to this property success: true Whether the API call was successful Link to this property

[Link to this property](<#(resource)%20alerting.silences%20%3E%20(model)%20silence_delete_response%20%3E%20(schema)>)