--- title: Rules Lists --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Rules Lists #### Rules ListsLists ##### [Get lists](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/methods/list) client.rules.lists.list(ListListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [ListsList]() {id, created\_on, kind, 5 more } > GET/accounts/{account\_id}/rules/lists ##### [Get a list](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/methods/get) client.rules.lists.get(stringlistID, ListGetParams {account\_id } params, RequestOptionsoptions?): [ListGetResponse]() {id, created\_on, kind, 5 more } GET/accounts/{account\_id}/rules/lists/{list\_id} ##### [Create a list](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/methods/create) client.rules.lists.create(ListCreateParams {account\_id, kind, name, description } params, RequestOptionsoptions?): [ListCreateResponse]() {id, created\_on, kind, 5 more } POST/accounts/{account\_id}/rules/lists ##### [Update a list](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/methods/update) client.rules.lists.update(stringlistID, ListUpdateParams {account\_id, description } params, RequestOptionsoptions?): [ListUpdateResponse]() {id, created\_on, kind, 5 more } PUT/accounts/{account\_id}/rules/lists/{list\_id} ##### [Delete a list](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/methods/delete) client.rules.lists.delete(stringlistID, ListDeleteParams {account\_id } params, RequestOptionsoptions?): [ListDeleteResponse]() {id } DELETE/accounts/{account\_id}/rules/lists/{list\_id} ##### ModelsExpand Collapse

Hostname {url\_hostname, exclude\_exact\_hostname } Hostnames support ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (\*), and the hyphen (-).

url\_hostname: string Link to this property exclude\_exact\_hostname?: boolean 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)>)

ListsList {id, created\_on, kind, 5 more }

id: string The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property

kind: "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: string The RFC 3339 timestamp of when the list was last modified. Link to this property name: string An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property num\_items: number The number of items in the list. Link to this property num\_referencing\_filters: number The number of filters referencing the list. Link to this property description?: string 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)>)

Redirect {source\_url, target\_url, include\_subdomains, 4 more } The definition of the redirect.

source\_url: string Link to this property target\_url: string Link to this property include\_subdomains?: boolean Link to this property preserve\_path\_suffix?: boolean Link to this property preserve\_query\_string?: boolean Link to this property

status\_code?: 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?: boolean Link to this property

[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20redirect%20%3E%20(schema)>)

ListGetResponse {id, created\_on, kind, 5 more }

id: string The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property

kind: "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](<#(resource)%20rules.lists%20%3E%20(model)%20list_get_response%20%3E%20(schema)>)

ListCreateResponse {id, created\_on, kind, 5 more }

id: string The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property

kind: "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](<#(resource)%20rules.lists%20%3E%20(model)%20list_create_response%20%3E%20(schema)>)

ListUpdateResponse {id, created\_on, kind, 5 more }

id: string The unique ID of the list. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property

kind: "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](<#(resource)%20rules.lists%20%3E%20(model)%20list_update_response%20%3E%20(schema)>)

ListDeleteResponse {id }

id: string 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)>) #### Rules ListsListsBulk Operations ##### [Get bulk operation status](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/bulk_operations/methods/get) client.rules.lists.bulkOperations.get(stringoperationID, BulkOperationGetParams {account\_id } params, RequestOptionsoptions?): [BulkOperationGetResponse]() GET/accounts/{account\_id}/rules/lists/bulk\_operations/{operation\_id} ##### ModelsExpand Collapse

BulkOperationGetResponse = ListsBulkOperationPendingOrRunning {id, status } | ListsBulkOperationCompleted {id, completed, status } | ListsBulkOperationFailed {id, completed, error, status }

One of the following:

ListsBulkOperationPendingOrRunning {id, status }

id: string The unique operation ID of the asynchronous action. Link to this property

status: "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

ListsBulkOperationCompleted {id, completed, status }

id: string The unique operation ID of the asynchronous action. Link to this property completed: string The RFC 3339 timestamp of when the operation was completed. Link to this property status: "completed" The current status of the asynchronous operation. Link to this property

Link to this property

ListsBulkOperationFailed {id, completed, error, status }

id: string The unique operation ID of the asynchronous action. Link to this property completed: string The RFC 3339 timestamp of when the operation was completed. Link to this property error: string A message describing the error when the status is failed. Link to this property status: "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)>) #### Rules ListsListsItems ##### [Get list items](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/items/methods/list) client.rules.lists.items.list(stringlistID, ItemListParams {account\_id, cursor, per\_page, search } params, RequestOptionsoptions?): CursorPaginationAfter< [ItemListResponse]()> GET/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Get a list item](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/items/methods/get) client.rules.lists.items.get(stringitemID, ItemGetParams {account\_id, list\_id } params, RequestOptionsoptions?): [ItemGetResponse]() GET/accounts/{account\_id}/rules/lists/{list\_id}/items/{item\_id} ##### [Create list items](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/items/methods/create) client.rules.lists.items.create(stringlistID, ItemCreateParams {account\_id, body } params, RequestOptionsoptions?): [ItemCreateResponse]() {operation\_id } POST/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Update all list items](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/items/methods/update) client.rules.lists.items.update(stringlistID, ItemUpdateParams {account\_id, body } params, RequestOptionsoptions?): [ItemUpdateResponse]() {operation\_id } PUT/accounts/{account\_id}/rules/lists/{list\_id}/items ##### [Delete list items](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/items/methods/delete) client.rules.lists.items.delete(stringlistID, ItemDeleteParams {account\_id, items } params, RequestOptionsoptions?): [ItemDeleteResponse]() {operation\_id } DELETE/accounts/{account\_id}/rules/lists/{list\_id}/items ##### ModelsExpand Collapse

ListCursor {after, before }

after?: string Link to this property before?: string Link to this property

[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20list_cursor%20%3E%20(schema)>)

ListItem {operation\_id }

operation\_id: string 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 = ListsListItemIPFull {id, created\_on, ip, 2 more } | ListsListItemHostnameFull {id, created\_on, hostname, 2 more } | ListsListItemRedirectFull {id, created\_on, modified\_on, 2 more } | ListsListItemASNFull {id, asn, created\_on, 2 more }

One of the following:

ListsListItemIPFull {id, created\_on, ip, 2 more }

id: string Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property ip: string An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR. Link to this property modified\_on: string The RFC 3339 timestamp of when the list was last modified. Link to this property comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemHostnameFull {id, created\_on, hostname, 2 more }

id: string Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property hostname: Hostname {url\_hostname, exclude\_exact\_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: string The RFC 3339 timestamp of when the list was last modified. Link to this property comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemRedirectFull {id, created\_on, modified\_on, 2 more }

id: string Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: string The RFC 3339 timestamp of when the list was last modified. Link to this property redirect: Redirect {source\_url, target\_url, include\_subdomains, 4 more } The definition of the redirect. Link to this property comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemASNFull {id, asn, created\_on, 2 more }

id: string Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property asn: number Defines a non-negative 32 bit integer. Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: string The RFC 3339 timestamp of when the list was last modified. Link to this property comment?: string 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 = ListsListItemIPFull {id, created\_on, ip, 2 more } | ListsListItemHostnameFull {id, created\_on, hostname, 2 more } | ListsListItemRedirectFull {id, created\_on, modified\_on, 2 more } | ListsListItemASNFull {id, asn, created\_on, 2 more }

One of the following:

ListsListItemIPFull {id, created\_on, ip, 2 more }

Link to this property

ListsListItemHostnameFull {id, created\_on, hostname, 2 more }

id: string Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property hostname: Hostname {url\_hostname, exclude\_exact\_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: string The RFC 3339 timestamp of when the list was last modified. Link to this property comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemRedirectFull {id, created\_on, modified\_on, 2 more }

id: string Defines the unique ID of the item in the List. maxLength32 minLength32 Link to this property created\_on: string The RFC 3339 timestamp of when the list was created. Link to this property modified\_on: string The RFC 3339 timestamp of when the list was last modified. Link to this property redirect: Redirect {source\_url, target\_url, include\_subdomains, 4 more } The definition of the redirect. Link to this property comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemASNFull {id, asn, created\_on, 2 more }

Link to this property

[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(model)%20item_get_response%20%3E%20(schema)>)

ItemCreateResponse {operation\_id }

operation\_id: string 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)>)

ItemUpdateResponse {operation\_id }

operation\_id: string 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)>)

ItemDeleteResponse {operation\_id }

operation\_id: string 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)>)