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.

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

Parameters
zone_id: string
(maxLength: 32)

Identifier

rate_limit_id: string
(maxLength: 32)

The unique identifier of the rate limit.

Response fields
errors: Array<>
messages: Array<>
result:
success: true

Whether the API call was successful

Request example
200Example
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.

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.

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

An HTTP method or _ALL_ to indicate all methods.

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