Update a Notification policy

PUT

https://api.cloudflare.com/client/v4/accounts/{identifier}/alerting/v3/policies/{uuid}

Last modified:2022-12-16 13:48:33

Update a Notification policy.

Request

Path Params

uuid

string

required

identifier

string

required

Body Params application/json

alert_type

string

optional

Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.

Example:

universal_ssl_event_type

description

string

optional

Optional description for the Notification policy.

Example:

Something describing the policy.

enabled

boolean

optional

Whether or not the Notification policy is enabled.

Default:

true

Example:

true

filters

object (components-schemas-filters)

optional

Example:

{"slo":["99.9"]}

Additional properties

array

optional

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.

mechanisms

object (mechanisms)

optional

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

Example:

{"email":[{"id":"test@example.com"}],"pagerduty":[{"id":"e8133a15-00a4-4d69-aec1-32f70c51f6e5"}],"webhooks":[{"id":"14cc1190-5d2b-4b98-a696-c424cb2ad05f"}]}

Additional properties

array [object]

optional

name

string

optional

Name of the policy.

Example:

SSL Notification Event Policy

Example

{
    "alert_type": "universal_ssl_event_type",
    "description": "Something describing the policy.",
    "enabled": true,
    "filters": {
        "slo": [
            "99.9"
        ]
    },
    "mechanisms": {
        "email": [
            {
                "id": "test@example.com"
            }
        ],
        "pagerduty": [
            {
                "id": "e8133a15-00a4-4d69-aec1-32f70c51f6e5"
            }
        ],
        "webhooks": [
            {
                "id": "14cc1190-5d2b-4b98-a696-c424cb2ad05f"
            }
        ]
    },
    "name": "SSL Notification Event Policy"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//alerting/v3/policies/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "alert_type": "universal_ssl_event_type",
    "description": "Something describing the policy.",
    "enabled": true,
    "filters": {
        "slo": [
            "99.9"
        ]
    },
    "mechanisms": {
        "email": [
            {
                "id": "test@example.com"
            }
        ],
        "pagerduty": [
            {
                "id": "e8133a15-00a4-4d69-aec1-32f70c51f6e5"
            }
        ],
        "webhooks": [
            {
                "id": "14cc1190-5d2b-4b98-a696-c424cb2ad05f"
            }
        ]
    },
    "name": "SSL Notification Event Policy"
}'

Responses

🟢200Update a Notification policy response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    },
    "success": true
}

🟢200Update a Notification policy response failure

Modified at 2022-12-16 13:48:33

Get a Notification policy

List webhooks