Create Silences

client.alerting.silences.create(, ?): SilenceCreateResponse { errors, messages, success }

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

Creates a new silence for an account.

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

params: SilenceCreateParams { account_id, body }

account_id: string

Path param: The account id

maxLength32

body: Array<Body>

Body param

end_time?: string

When the silence ends.

policy_id?: string

The unique identifier of a notification policy

maxLength32

start_time?: string

When the silence starts.

ReturnsExpand Collapse

SilenceCreateResponse { errors, messages, success }

errors: Array<Error>

message: string

code?: number

minimum1000

messages: Array<Message>

message: string

code?: number

minimum1000

success: true

Whether the API call was successful

Create Silences

import Cloudflare from 'cloudflare';

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

const silence = await client.alerting.silences.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  body: [{}],
});

console.log(silence.errors);

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

Returns Examples

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