Create Silences

client.Alerting.Silences.New(ctx, params) (*SilenceNewResponse, error)

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 SilenceNewParams

AccountID param.Field[string]

Path param: The account id

maxLength32

Body param.Field[[]SilenceNewParamsBody]

Body param

EndTime stringoptional

When the silence ends.

PolicyID stringoptional

The unique identifier of a notification policy

maxLength32

StartTime stringoptional

When the silence starts.

ReturnsExpand Collapse

type SilenceNewResponse struct{…}

Errors []SilenceNewResponseError

Message string

Code int64optional

minimum1000

Messages []SilenceNewResponseMessage

Message string

Code int64optional

minimum1000

Success SilenceNewResponseSuccess

Whether the API call was successful

Create Silences

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/alerting"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  silence, err := client.Alerting.Silences.New(context.TODO(), alerting.SilenceNewParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Body: []alerting.SilenceNewParamsBody{alerting.SilenceNewParamsBody{

    }},
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
}