Cloudflare API | Rate Limits › List Rate Limits

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Create a rate limit

Delete a rate limit

Update a rate limit

Get a rate limit

List rate limits

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Rate Limits

rate_limits

Methods

Create A Rate Limit -> Envelope<

>

Deprecated

post/zones/{zone_id}/rate_limits

Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes.

Delete A Rate Limit -> Envelope<{ id, action, bypass, 5 more... }>

Deprecated

delete/zones/{zone_id}/rate_limits/{rate_limit_id}

Deletes an existing rate limit.

Update A Rate Limit -> Envelope<

>

Deprecated

put/zones/{zone_id}/rate_limits/{rate_limit_id}

Updates an existing rate limit.

Get A Rate Limit -> Envelope<

>

Deprecated

get/zones/{zone_id}/rate_limits/{rate_limit_id}

Fetches the details of a rate limit.

List Rate Limits -> V4PagePaginationArray<

>

Deprecated

get/zones/{zone_id}/rate_limits

Fetches the rate limits for a zone.

Security

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)

Firewall Services Write Firewall Services Read

Parameters

zone_id: string

Identifier

page: number

Optional

The page number of paginated results.

per_page: number

Optional

The maximum number of results per page. You can only set the value to 1 or to a multiple of 5 such as 5, 10, 15, or 20.

Response fields

errors: Array<

>

messages: Array<

>

result: Array<

>

success: true

Whether the API call was successful

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rate_limits \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b59",
      "action": {
        "mode": "simulate",
        "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,
      "match": {
        "headers": [
          {
            "name": "Cf-Cache-Status",
            "op": "eq",
            "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
  }
}

Domain types

Action = "block" | "challenge" | "js_challenge" | 4 more...

Methods = "GET" | "POST" | "PUT" | 4 more...

RateLimit = { id, action, bypass, 5 more... }