← Waf / waf / tools / lists / lists-api

Lists API endpoints

To invoke a Lists API operation, append the endpoint to the Cloudflare API base URL:

https://api.cloudflare.com/client/v4/

For authentication instructions, refer to the Cloudflare API's Get started page.

For help with making API calls and paginating results, refer to Make API calls.

The Lists API supports the operations outlined below. Visit the associated links for examples.

• Operation: Create a list
• Method and endpoint: POST accounts/{account_id}/rules/lists
• Notes: Creates an empty list.

• Operation: Get lists
• Method and endpoint: GET accounts/{account_id}/rules/lists
• Notes:
  • Fetches all lists for the account.
  • This request does not fetch the items in the lists.

• Operation: Get a list
• Method and endpoint: GET accounts/{account_id}/rules/lists/{list_id}
• Notes:
  • Fetches a list by its ID.
  • This request does not display the items in the list.

• Operation: Update a list
• Method and endpoint: PUT accounts/{account_id}/rules/lists/{list_id}
• Notes:
  • Updates the description of a list.
  • You cannot edit the name or kind, and you cannot update items in a list. To update an item in a list, use the Update all list items operation.

• Operation: Delete a list
• Method and endpoint: DELETE accounts/{account_id}/rules/lists/{list_id}
• Notes: Deletes the list, but only when no filters reference it.

Nearly all the operations for managing items in a list are asynchronous. When you add or delete a large amount of items to or from a list, there may be a delay before the bulk operation is complete.

Asynchronous list operations return an operation_id, which you can use to monitor the status of an API operation. To monitor the status of an asynchronous operation, use the Get bulk operation status endpoint and specify the ID of the operation you want to monitor.

When you make requests to a list while a bulk operation on that list is in progress, the requests are queued and processed in sequence (first in, first out). Requests for successful asynchronous operations return an HTTP 201 status code.

• Operation: Get list items
• Method and endpoint: GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]
• Notes:
  • Fetches items in a list (all items, by default).
  • Items are sorted in ascending order.
  • In the case of IP lists, CIDRs are sorted by IP address, then by the subnet mask.
  • To filter returned items, use the optional search query string parameter. For more information, refer to the Get list items API operation.

• Operation: Get a list item
• Method and endpoint: GET accounts/{account_id}/rules/lists/{list_id}/items/{item_id}
• Notes: Fetches an item from a list by ID

• Operation: Create list items
• Method and endpoint: POST accounts/{account_id}/rules/lists/{list_id}/items
• Notes:
  • Appends a new item or items to a list.
  • Replaces entries that already exist in the list, does not delete any items.
  • Overwrites the comment of the original item.
  • The response includes an operation_id.

• Operation: Update all list items
• Method and endpoint: PUT accounts/{account_id}/rules/lists/{list_id}/items
• Notes:
  • Deletes all current items in the list and replaces them with items.
  • When items is empty, deletes all items in the list.
  • The response includes an operation_id.

• Operation: Delete list items
• Method and endpoint: DELETE accounts/{account_id}/rules/lists/{list_id}/items
• Notes:
  • Deletes specified list items.
  • The response includes an operation_id.