List rate limits

Fetches the rate limits for a zone.

application/json

Body

result

required

Any of

allOf {2}

array[object (rate-limits) {8}]

allOf {2}

One of

array[object (rate-limits) {8}]

object

action

components-schemas-action

optional

The action to perform when the threshold of matched traffic within the configured period is exceeded.

bypass

array [object {2}]

bypass

optional

Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.

description

string

components-schemas-description

optional

An informative summary of the rate limit. This value is sanitized and any tags will be removed.

<= 1024 characters

Example:

Prevent multiple login failures to mitigate brute force attacks

disabled

boolean

disabled

optional

When true, indicates that the rate limit is currently disabled.

Example:

false

string

rate-limits_components-schemas-id

read-onlyoptional

The unique identifier of the rate limit.

<= 32 characters

Example:

372e67954025e0ba6aaa6d586b9e0b59

match

optional

Determines which traffic the rate limit counts towards the threshold.

period

number

period

optional

The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.

>= 10<= 86400

Example:

900

threshold

number

threshold

optional

The threshold that will trigger the configured mitigation action. Configure this value along with the period property to establish a threshold per period.

>= 1

Example:

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": [
        {
            "action": {
                "mode": "challenge",
                "response": {
                    "body": "<error>This request has been rate-limited.</error>",
                    "content_type": "text/xml"
                },
                "timeout": 86400
            },
            "bypass": [
                {
                    "name": "url",
                    "value": "api.example.com/*"
                }
            ],
            "description": "Prevent multiple login failures to mitigate brute force attacks",
            "disabled": false,
            "id": "372e67954025e0ba6aaa6d586b9e0b59",
            "match": {
                "headers": [
                    {
                        "name": "Cf-Cache-Status",
                        "op": "ne",
                        "value": "HIT"
                    }
                ],
                "request": {
                    "methods": [
                        "GET",
                        "POST"
                    ],
                    "schemes": [
                        "HTTP",
                        "HTTPS"
                    ],
                    "url": "*.example.org/path*"
                },
                "response": {
                    "origin_traffic": true
                }
            },
            "period": 900,
            "threshold": 60
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses