Cloudflare Docs
WAF
Edit this page on GitHub
Set theme to dark (⇧+D)

Lists API

The Lists API provides an interface for programmatically managing the following types of lists:

  • Custom lists: Contain one or more strings of the same type (such as IP addresses or hostnames) that you can reference collectively, by name, in rule expressions.

  • Bulk Redirect Lists: Contain URL redirects that you enable by creating a Bulk Redirect Rule.

To use a list in a rule expression, refer to Values: Lists in the Rules language documentation.

​​ Get started

To get started, review the Lists JSON object and Endpoints.


​​ Rate limiting for Lists API requests

Cloudflare may apply rate limiting to API requests creating or deleting list items in custom lists and Bulk Redirect Lists.

Each operation (create or delete) on a list item counts as a change. The changes requested in an API request are internally queued and processed by Cloudflare. You can have approximately 1,000 pending list changes waiting to be processed before your requests are rate limited.

Once the system has processed enough changes so that they are under the threshold mentioned above, you can make additional API requests with more changes.