Cloudflare API | Rate Limits › Create A Rate Limit

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rate_limits \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "action": {},
      "match": {},
      "period": 900,
      "threshold": 60
    }'

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
}

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

Deprecated

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

Deprecated

Deletes an existing rate limit.

Update A Rate Limit -> Envelope<

RateLimit

Deprecated

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

Deprecated

Updates an existing rate limit.

Get A Rate Limit -> Envelope<

RateLimit

Deprecated

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

Deprecated

Fetches the details of a rate limit.

List Rate Limits -> V4PagePaginationArray<

RateLimit

Deprecated

get/zones/{zone_id}/rate_limits

Deprecated

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... }