Cloudflare API | Alerting › Policies › Create A Notification Policy

API Reference

Account & User Management

Available Alerts

Create a Notification policy

Delete a Notification policy

Get a Notification policy

List Notification policies

Update a Notification policy

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 Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Alerting

alerting

Available Alerts

alerting.available_alerts

Methods

Get Alert Types -> Envelope<Record<string, Array<{ description, display_name, filter_options, 1 more... }>>>

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

Get Delivery Mechanism Eligibility -> Envelope<Record<string, Array<{ eligible, ready, type }>>>

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.pagerduty

Methods

Create Pager Duty Integration Token -> Envelope<{ id }>

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

Creates a new token for integrating with PagerDuty.

Delete Pager Duty Services -> { errors, messages, success, 1 more... }

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

Deletes all the PagerDuty Services connected to the account.

List Pager Duty Services -> Envelope<Array<

>>

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

Get a list of all configured PagerDuty services.

Connect Pager Duty -> Envelope<{ id }>

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

Links PagerDuty with the account using the integration token.

Domain types

Pagerduty = { id, name }

Alerting Destinations

Webhooks

alerting.destinations.webhooks

Methods

Create A Webhook -> Envelope<{ id }>

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

Creates a new webhook destination.

Delete A Webhook -> { errors, messages, success, 1 more... }

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

Delete a configured webhook destination.

Get A Webhook -> Envelope<

>

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

Get details for a single webhooks destination.

List Webhooks -> SinglePage<

>

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

Gets a list of all configured webhook destinations.

Update A Webhook -> Envelope<{ id }>

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

Update a webhook destination.

Domain types

Webhooks = { id, created_at, last_failure, 5 more... }

History

alerting.history

Methods

List History -> 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 = { id, alert_body, alert_type, 6 more... }

Policies

alerting.policies

Methods

Create A Notification Policy -> Envelope<{ id }>

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

Creates a new Notification policy.

Security

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Notifications Write Account Settings Write

Parameters

account_id: string

The account id

Response fields

errors: Array<

>

messages: Array<

>

success: true

Whether the API call was successful

result: { id }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/alerting/v3/policies \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "alert_type": "access_custom_certificate_expiration_type",
      "enabled": true,
      "mechanisms": {
        "email": [
          {}
        ],
        "pagerduty": [
          {}
        ],
        "webhooks": [
          {}
        ]
      },
      "name": "SSL Notification Event Policy",
      "alert_interval": "30m",
      "description": "Something describing the policy.",
      "filters": {}
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}

Delete A Notification Policy -> { errors, messages, success, 1 more... }

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

Delete a Notification policy.

Get A Notification Policy -> Envelope<

>

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

Get details for a single policy.

List Notification Policies -> SinglePage<

>

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

Get a list of all Notification policies.

Update A Notification Policy -> Envelope<{ id }>

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

Update a Notification policy.

Domain types

Mechanism = Record<string, Array<{ id }>>

Policy = { id, alert_interval, alert_type, 7 more... }

PolicyFilter = { actions, affected_asns, affected_components, 38 more... }