Create an IP Access rule

POST

https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules

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

Creates a new IP Access rule for all zones owned by the current user.

Note: To create an IP Access rule that applies to a specific zone, refer to the IP Access rules for a zone endpoints.

Request

Body Params application/json

configuration

schemas-configuration

required

The rule configuration.

target

optional

The configuration target. You must set the target to ip when specifying an IP address in the rule.

Allowed value:

Example:

value

string

optional

The IP address to match. This address will be compared to the IP address of incoming requests.

Example:

198.51.100.4

mode

enum<string>

required

The action to apply to a matched request.

Allowed values:

blockchallengewhitelistjs_challengemanaged_challenge

Example:

challenge

notes

string

optional

An informative summary of the rule, typically used as a reminder or explanation.

Example:

This rule is enabled because of an event that occurred on date X.

Example

{
    "configuration": {
        "target": "ip",
        "value": "198.51.100.4"
    },
    "mode": "challenge",
    "notes": "This rule is enabled because of an event that occurred on date X."
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configuration": {
        "target": "ip",
        "value": "198.51.100.4"
    },
    "mode": "challenge",
    "notes": "This rule is enabled because of an event that occurred on date X."
}'

Responses

🟢200Create an IP Access rule 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 (Cloudflare Client API_rule)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "allowed_modes": [
            "whitelist",
            "block",
            "challenge",
            "js_challenge",
            "managed_challenge"
        ],
        "configuration": {
            "target": "ip",
            "value": "198.51.100.4"
        },
        "created_on": "2014-01-01T05:20:00.12345Z",
        "id": "92f17202ed8bd63d69a66b86a49a8f6b",
        "mode": "challenge",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "notes": "This rule is enabled because of an event that occurred on date X."
    },
    "success": true
}

🟢200Create an IP Access rule response failure

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

List IP Access rules

Delete an IP Access rule