Cloudflare API | Alerting › 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).

Security

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Cloudflare Zero Trust PII Read Notifications Write Notifications Read Account Settings Write Account Settings Read

Parameters

account_id: string

(maxLength: 32)

The account id

before: string

Optional

(format: date-time)

Limit the returned results to history records older than the specified date. This must be a timestamp that conforms to RFC3339.

page: number

Optional

(minimum: 1)

Page number of paginated results.

per_page: number

Optional

(maximum: 1000, minimum: 5)

Number of items per page.

since: string

Optional

(format: date-time)

Limit the returned results to history records newer than the specified date. This must be a timestamp that conforms to RFC3339.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: Array<

History

Optional

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/alerting/v3/history \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "alert_body": "SSL certificate has expired",
      "alert_type": "universal_ssl_event_type",
      "description": "Universal Certificate validation status, issuance, renewal, and expiration notices",
      "mechanism": "test@example.com",
      "mechanism_type": "email",
      "name": "SSL Notification Event Policy",
      "policy_id": "0da2b59e-f118-439d-8097-bdfb215203c9",
      "sent": "2021-10-08T17:52:17.571336Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Domain types

History = { id, alert_body, alert_type, 6 more... }

Alerting

Policies

alerting.policies

Methods

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

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

Creates a new Notification policy.

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<

Policy

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

Get details for a single policy.

List Notification Policies -> SinglePage<

Policy

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 }>>

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

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

PolicyFilter = { actions, affected_asns, affected_components, 38 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.