Cloudflare API | Rate Limits › Get A Rate Limit

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 Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

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

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Rate Limits

rate_limits

Methods

Create A Rate Limit -> Envelope<

>

Deprecated

post/zones/{zone_id}/rate_limits

Deprecated

Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.

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}

Deprecated

Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.

Deletes an existing rate limit.

Update A Rate Limit -> Envelope<

>

Deprecated

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

Deprecated

Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.

Updates an existing rate limit.

Get A Rate Limit -> Envelope<

>

Deprecated

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

Deprecated

Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.

Fetches the details of a rate limit.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Firewall Services Write Firewall Services Read

path Parameters

zone_id: string

(maxLength: 32)

Defines an identifier.

rate_limit_id: string

(maxLength: 32)

Defines the unique identifier of the rate limit.

Response fields

errors: Array<

>

messages: Array<

>

result:

success: true

Defines whether the API call was successful.

Request example

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

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "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,
    "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
}

List Rate Limits -> V4PagePaginationArray<

>

Deprecated

get/zones/{zone_id}/rate_limits

Deprecated

Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.

Fetches the rate limits for a zone.

Domain types

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

The action to apply to a matched request. The log action is only available on an Enterprise plan.

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