--- title: Lists --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Rules Lists](https://developers.cloudflare.com/api/python/resources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Lists ##### [Get lists](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/methods/list) rules.lists.list(ListListParams\*\*kwargs) -> SyncSinglePage\[[ListsList]()] GET/accounts/{account\_id}/rules/lists ##### [Get a list](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/methods/get) rules.lists.get(strlist\_id, ListGetParams\*\*kwargs) -> [ListGetResponse]() GET/accounts/{account\_id}/rules/lists/{list\_id} ##### [Create a list](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/methods/create) rules.lists.create(ListCreateParams\*\*kwargs) -> [ListCreateResponse]() POST/accounts/{account\_id}/rules/lists ##### [Update a list](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/methods/update) rules.lists.update(strlist\_id, ListUpdateParams\*\*kwargs) -> [ListUpdateResponse]() PUT/accounts/{account\_id}/rules/lists/{list\_id} ##### [Delete a list](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/methods/delete) rules.lists.delete(strlist\_id, ListDeleteParams\*\*kwargs) -> [ListDeleteResponse]() DELETE/accounts/{account\_id}/rules/lists/{list\_id} ##### ModelsExpand Collapse
class Hostname: … Hostnames support ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (\*), and the hyphen (-). url\_hostname: str Link to this property exclude\_exact\_hostname: Optional\[bool] Only applies to wildcard hostnames (e.g., \*.example.com). When true (default), the rule blocks only subdomains. When false, the rule blocks both the root domain and subdomains. Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20hostname%20%3E%20(schema)>)
class ListsList: … id: str The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property
kind: Literal\["ip", "redirect", "hostname", "asn"] The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). One of the following: "ip" Link to this property "redirect" Link to this property "hostname" Link to this property "asn" Link to this property
Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property name: str An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property num\_items: float The number of items in the list. Link to this property num\_referencing\_filters: float The number of filters referencing the list. Link to this property description: Optional\[str] An informative summary of the list. maxLength500 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20lists_list%20%3E%20(schema)>)
class Redirect: … The definition of the redirect. source\_url: str Link to this property target\_url: str Link to this property include\_subdomains: Optional\[bool] Link to this property preserve\_path\_suffix: Optional\[bool] Link to this property preserve\_query\_string: Optional\[bool] Link to this property
status\_code: Optional\[Literal\[301, 302, 307, 308]] One of the following: 301 Link to this property 302 Link to this property 307 Link to this property 308 Link to this property
Link to this property subpath\_matching: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20redirect%20%3E%20(schema)>)
class ListGetResponse: … id: str The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property
kind: Literal\["ip", "redirect", "hostname", "asn"] The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). One of the following: "ip" Link to this property "redirect" Link to this property "hostname" Link to this property "asn" Link to this property
Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property name: str An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property num\_items: float The number of items in the list. Link to this property num\_referencing\_filters: float The number of filters referencing the list. Link to this property description: Optional\[str] An informative summary of the list. maxLength500 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20list_get_response%20%3E%20(schema)>)
class ListCreateResponse: … id: str The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property
kind: Literal\["ip", "redirect", "hostname", "asn"] The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). One of the following: "ip" Link to this property "redirect" Link to this property "hostname" Link to this property "asn" Link to this property
Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property name: str An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property num\_items: float The number of items in the list. Link to this property num\_referencing\_filters: float The number of filters referencing the list. Link to this property description: Optional\[str] An informative summary of the list. maxLength500 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20list_create_response%20%3E%20(schema)>)
class ListUpdateResponse: … id: str The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property
kind: Literal\["ip", "redirect", "hostname", "asn"] The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). One of the following: "ip" Link to this property "redirect" Link to this property "hostname" Link to this property "asn" Link to this property
Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property name: str An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property num\_items: float The number of items in the list. Link to this property num\_referencing\_filters: float The number of filters referencing the list. Link to this property description: Optional\[str] An informative summary of the list. maxLength500 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20list_update_response%20%3E%20(schema)>)
class ListDeleteResponse: … id: str The unique ID of the list. maxLength32 minLength32 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20list_delete_response%20%3E%20(schema)>) #### ListsBulk Operations ##### [Get bulk operation status](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/subresources/bulk_operations/methods/get) rules.lists.bulk\_operations.get(stroperation\_id, BulkOperationGetParams\*\*kwargs) -> [BulkOperationGetResponse]() GET/accounts/{account\_id}/rules/lists/bulk\_operations/{operation\_id} ##### ModelsExpand Collapse
BulkOperationGetResponse One of the following:
class ListsBulkOperationPendingOrRunning: … id: str The unique operation ID of the asynchronous action. Link to this property
status: Literal\["pending", "running"] The current status of the asynchronous operation. One of the following: "pending" Link to this property "running" Link to this property
Link to this property
Link to this property
class ListsBulkOperationCompleted: … id: str The unique operation ID of the asynchronous action. Link to this property completed: str The RFC 3339 timestamp of when the operation was completed. Link to this property status: Literal\["completed"] The current status of the asynchronous operation. Link to this property
Link to this property
class ListsBulkOperationFailed: … id: str The unique operation ID of the asynchronous action. Link to this property completed: str The RFC 3339 timestamp of when the operation was completed. Link to this property error: str A message describing the error when the status is failed. Link to this property status: Literal\["failed"] The current status of the asynchronous operation. Link to this property
Link to this property
[Link to this property](<#(resource)%20rules.lists.bulk_operations%20%3E%20(model)%20bulk_operation_get_response%20%3E%20(schema)>) #### ListsItems ##### [Get list items](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/subresources/items/methods/list) rules.lists.items.list(strlist\_id, ItemListParams\*\*kwargs) -> SyncCursorPaginationAfter\[[ItemListResponse]()] GET/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Get a list item](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/subresources/items/methods/get) rules.lists.items.get(stritem\_id, ItemGetParams\*\*kwargs) -> [ItemGetResponse]() GET/accounts/{account\_id}/rules/lists/{list\_id}/items/{item\_id} ##### [Create list items](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/subresources/items/methods/create) rules.lists.items.create(strlist\_id, ItemCreateParams\*\*kwargs) -> [ItemCreateResponse]() POST/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Update all list items](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/subresources/items/methods/update) rules.lists.items.update(strlist\_id, ItemUpdateParams\*\*kwargs) -> [ItemUpdateResponse]() PUT/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Delete list items](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists/subresources/items/methods/delete) rules.lists.items.delete(strlist\_id, ItemDeleteParams\*\*kwargs) -> [ItemDeleteResponse]() DELETE/accounts/{account\_id}/rules/lists/{list\_id}/items ##### ModelsExpand Collapse
class ListCursor: … after: Optional\[str] Link to this property before: Optional\[str] Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20list_cursor%20%3E%20(schema)>)
class ListItem: … operation\_id: str The unique operation ID of the asynchronous action. Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20list_item%20%3E%20(schema)>)
ItemListResponse One of the following:
class ListsListItemIPFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property ip: str An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR. Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
class ListsListItemHostnameFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property hostname: Hostname Hostnames support ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (\*), and the hyphen (-). Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
class ListsListItemRedirectFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property redirect: Redirect The definition of the redirect. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
class ListsListItemASNFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property asn: int Defines a non-negative 32 bit integer. Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20item_list_response%20%3E%20(schema)>)
ItemGetResponse One of the following:
class ListsListItemIPFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property ip: str An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR. Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
class ListsListItemHostnameFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property hostname: Hostname Hostnames support ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (\*), and the hyphen (-). Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
class ListsListItemRedirectFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property redirect: Redirect The definition of the redirect. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
class ListsListItemASNFull: … id: str Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property asn: int Defines a non-negative 32 bit integer. Link to this property created\_on: str The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: str The RFC 3339 timestamp of when the list was last modified. Link to this property comment: Optional\[str] Defines an informative summary of the list item. Link to this property
Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20item_get_response%20%3E%20(schema)>)
class ItemCreateResponse: … operation\_id: str The unique operation ID of the asynchronous action. Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20item_create_response%20%3E%20(schema)>)
class ItemUpdateResponse: … operation\_id: str The unique operation ID of the asynchronous action. Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20item_update_response%20%3E%20(schema)>)
class ItemDeleteResponse: … operation\_id: str The unique operation ID of the asynchronous action. Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20item_delete_response%20%3E%20(schema)>)