> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/cloudflare/cloudflare-typescript/llms.txt
> Use this file to discover all available pages before exploring further.
# Alerting
> API reference for Cloudflare Alerting (notifications and alerts)
## Overview
Cloudflare Alerting sends notifications when events occur on your Cloudflare account or zones. Manage alert policies, notification destinations, and view alert history.
## Initialize the client
```typescript theme={null}
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: 'your-api-token',
});
```
## Policies
Manage alert policies.
### Create a policy
Create a new alert policy.
```typescript theme={null}
const policy = await client.alerting.policies.create({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
name: 'SSL Certificate Expiring',
alert_type: 'universal_ssl_event_type',
enabled: true,
mechanisms: {
email: [{ id: 'user@example.com' }],
},
});
```
Account identifier
Policy name
Type of alert (e.g., `universal_ssl_event_type`, `dos_attack_l7`, `health_check_status_notification`)
Whether the policy is active
Notification mechanisms (email, webhook, PagerDuty, etc.)
Conditions that trigger the alert
Policy identifier
Policy name
When the policy was created
When the policy was last modified
### Update a policy
Update an existing alert policy.
```typescript theme={null}
const policy = await client.alerting.policies.update(
policyId,
{
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
enabled: false,
}
);
```
### List policies
List all alert policies.
```typescript theme={null}
const policies = await client.alerting.policies.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
```
### Get a policy
Get details of a specific alert policy.
```typescript theme={null}
const policy = await client.alerting.policies.get(
policyId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
### Delete a policy
Delete an alert policy.
```typescript theme={null}
await client.alerting.policies.delete(
policyId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
## Destinations
Manage notification destinations.
```typescript theme={null}
const destinations = client.alerting.destinations;
```
Destinations define where alerts are sent (email, webhook, PagerDuty, Slack, etc.).
## History
View alert history.
### List alert history
Retrieve a history of triggered alerts.
```typescript theme={null}
const history = await client.alerting.history.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
```
Account identifier
Filter alerts since this timestamp
Filter alerts before this timestamp
Alert history identifier
Alert name
Type of alert
When the alert was triggered
## Silences
Manage alert silences (temporarily disable alerts).
### Create a silence
Create a new alert silence.
```typescript theme={null}
const silence = await client.alerting.silences.create({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
description: 'Maintenance window',
start: '2024-01-01T00:00:00Z',
end: '2024-01-01T04:00:00Z',
});
```
Account identifier
Silence description
Start time (ISO 8601 format)
End time (ISO 8601 format)
### Update a silence
```typescript theme={null}
const silence = await client.alerting.silences.update(
silenceId,
params
);
```
### List silences
```typescript theme={null}
const silences = await client.alerting.silences.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
```
### Get a silence
```typescript theme={null}
const silence = await client.alerting.silences.get(
silenceId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
### Delete a silence
```typescript theme={null}
await client.alerting.silences.delete(
silenceId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
## Available alerts
Get information about available alert types.
### List available alerts
```typescript theme={null}
const alerts = await client.alerting.availableAlerts.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
```
Alert type identifier
Human-readable alert name
Alert description
## Types
### Mechanism
Notification delivery mechanism.
Email addresses to notify
Webhook URLs to call
PagerDuty integration keys
### PolicyFilter
Conditions for triggering alerts.
Zone IDs to monitor
Health check identifier (for health check alerts)