List IP Access rules

Fetches IP Access rules of a zone. You can filter the results using several optional parameters.

application/json

Body

result

required

Any of

allOf {2}

array[object (Cloudflare Client API_rule) {7}]

allOf {2}

One of

array[object (Cloudflare Client API_rule) {7}]

object

allowed_modes

array[string]

read-onlyrequired

The available actions that a rule can apply to a matched request.

Allowed values:

blockchallengewhitelistjs_challengemanaged_challenge

Example:

["whitelist","block","challenge","js_challenge","managed_challenge"]

configuration

schemas-configuration

required

The rule configuration.

created_on

string <date-time>

read-onlyoptional

The timestamp of when the rule was created.

Example:

2014-01-01T05:20:00.12345Z

string

rule_components-schemas-identifier

read-onlyrequired

The unique identifier of the IP Access rule.

<= 32 characters

Example:

92f17202ed8bd63d69a66b86a49a8f6b

mode

enum<string>

schemas-mode

required

The action to apply to a matched request.

Allowed values:

blockchallengewhitelistjs_challengemanaged_challenge

Example:

challenge

modified_on

string <date-time>

read-onlyoptional

The timestamp of when the rule was last modified.

Example:

2014-01-01T05:20:00.12345Z

notes

string

notes

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.

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

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,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List IP Access rules

Request

Request samples

Responses