Connect PagerDuty

client.alerting.destinations.pagerduty.link(, , ?): PagerdutyLinkResponse { id }

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

Links PagerDuty with the account using the integration token.

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Notifications WriteAccount Settings Write

ParametersExpand Collapse

tokenId: string

The token integration key

maxLength32

params: PagerdutyLinkParams { account_id }

account_id: string

The account id

maxLength32

ReturnsExpand Collapse

PagerdutyLinkResponse { id }

id?: string

UUID

maxLength32

Connect PagerDuty

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.alerting.destinations.pagerduty.link(
  '8c71e667571b4f61b94d9e4b12158038',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);

console.log(response.id);

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

Returns Examples

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