Cloudflare Docs
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 your 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 existing rate limit is based on the number of list changes over time. You can request a maximum of 10,000 list changes in five minutes.

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