Cloudflare API | Alerting

API Reference

Account & User Management

Available Alerts

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Alerting

Alerting

Available Alerts

Alerting.AvailableAlerts

Methods

client.alerting.availableAlerts.list(, ):

AvailableAlertListResponse

get/accounts/{account_id}/alerting/v3/available_alerts

Gets a list of all alert types for which an account is eligible.

Destinations

Alerting.Destinations

Alerting Destinations

Eligible

Alerting.Destinations.Eligible

Methods

client.alerting.destinations.eligible.get(, ):

EligibleGetResponse

get/accounts/{account_id}/alerting/v3/destinations/eligible

Get a list of all delivery mechanism types for which an account is eligible.

Alerting Destinations

Pagerduty

Alerting.Destinations.PagerdutyResource

Methods

client.alerting.destinations.pagerduty.get(, ):

<

>

get/accounts/{account_id}/alerting/v3/destinations/pagerduty

Get a list of all configured PagerDuty services.

client.alerting.destinations.pagerduty.create(, ):

PagerdutyCreateResponse

post/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect

Creates a new token for integrating with PagerDuty.

client.alerting.destinations.pagerduty.delete(, ):

PagerdutyDeleteResponse

delete/accounts/{account_id}/alerting/v3/destinations/pagerduty

Deletes all the PagerDuty Services connected to the account.

client.alerting.destinations.pagerduty.link(, , ):

PagerdutyLinkResponse

get/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}

Links PagerDuty with the account using the integration token.

Domain types

Pagerduty{…}

Alerting Destinations

Webhooks

Alerting.Destinations.Webhooks

Methods

client.alerting.destinations.webhooks.list(, ):

<

>

get/accounts/{account_id}/alerting/v3/destinations/webhooks

Gets a list of all configured webhook destinations.

client.alerting.destinations.webhooks.get(, , ):

get/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

Get details for a single webhooks destination.

client.alerting.destinations.webhooks.create(, ):

WebhookCreateResponse

post/accounts/{account_id}/alerting/v3/destinations/webhooks

Creates a new webhook destination.

client.alerting.destinations.webhooks.update(, , ):

WebhookUpdateResponse

put/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

Update a webhook destination.

client.alerting.destinations.webhooks.delete(, , ):

WebhookDeleteResponse

delete/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

Delete a configured webhook destination.

Domain types

Webhooks{…}

History

Alerting.HistoryResource

Methods

client.alerting.history.list(, ):

V4PagePaginationArray

<

>

get/accounts/{account_id}/alerting/v3/history

Gets a list of history records for notifications sent to an account. The records are displayed for last x number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).

Domain types

History{…}

Policies

Alerting.Policies

Methods

client.alerting.policies.list(, ):

<

>

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

Get a list of all Notification policies.

client.alerting.policies.get(, , ):

get/accounts/{account_id}/alerting/v3/policies/{policy_id}

Get details for a single policy.

client.alerting.policies.create(, ):

PolicyCreateResponse

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

Creates a new Notification policy.

client.alerting.policies.update(, , ):

PolicyUpdateResponse

put/accounts/{account_id}/alerting/v3/policies/{policy_id}

Update a Notification policy.

client.alerting.policies.delete(, , ):

PolicyDeleteResponse

delete/accounts/{account_id}/alerting/v3/policies/{policy_id}

Delete a Notification policy.

Domain types

Mechanism{…}

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

Policy{…}

PolicyFilter{…}

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.

Silences

Alerting.Silences

Methods

client.alerting.silences.list(, ):

<

SilenceListResponse

>

get/accounts/{account_id}/alerting/v3/silences

Gets a list of silences for an account.

client.alerting.silences.get(, , ):

SilenceGetResponse

get/accounts/{account_id}/alerting/v3/silences/{silence_id}

Gets a specific silence for an account.

client.alerting.silences.create(, ):

SilenceCreateResponse

post/accounts/{account_id}/alerting/v3/silences

Creates a new silence for an account.

client.alerting.silences.update(, ):

<

SilenceUpdateResponse

>

put/accounts/{account_id}/alerting/v3/silences

Updates existing silences for an account.

client.alerting.silences.delete(, , ):

SilenceDeleteResponse

delete/accounts/{account_id}/alerting/v3/silences/{silence_id}

Deletes an existing silence for an account.