Cloudflare API | Alerting › Destinations › Pagerduty › Create Pager Duty Integration Token

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/alerting/v3/destinations/pagerduty/connect \
    -X POST \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

200Example

{
  "errors": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "success": true,
  "result": {
    "id": "a313ba7d3e464c0ea40808fafbc3816a"
  }
}

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

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

Deletes all the PagerDuty Services connected to the account.

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

List Webhooks -> SinglePage<

Webhooks

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

Gets a list of all configured webhook destinations.

Get A Webhook -> Envelope<

Webhooks

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

Get details for a single webhooks destination.

Create A Webhook -> Envelope<{ id }>

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

Creates a new webhook destination.

Update A Webhook -> Envelope<{ id }>

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

Update a webhook destination.

Delete A Webhook -> { errors, messages, success }

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

Delete a configured webhook destination.

Domain types

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

Alerting

History

alerting.history

Methods

List History -> V4PagePaginationArray<

History

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

Alerting

Policies

alerting.policies

Methods

List Notification Policies -> SinglePage<

Policy

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

Get a list of all Notification policies.

Get A Notification Policy -> Envelope<

Policy

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

Get details for a single policy.

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

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

Creates a new Notification policy.

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

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

Update a Notification policy.

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

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

Delete a Notification policy.

Domain types

Mechanism = { email, pagerduty, webhooks }

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, 40 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.

Alerting

Silences

alerting.silences

Methods

List Silences -> SinglePage<{ id, created_at, end_time, 3 more... }>

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

Gets a list of silences for an account.

Get Silence -> Envelope<{ id, created_at, end_time, 3 more... }>

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

Gets a specific silence for an account.

Create Silences -> { errors, messages, success }

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

Creates a new silence for an account.

Update Silences -> SinglePage<{ id, created_at, end_time, 3 more... }>

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

Updates existing silences for an account.

Delete Silence -> { errors, messages, success }

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

Deletes an existing silence for an account.