---
title: Rules Lists
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api/terraform)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Rules Lists
#### Rules ListsLists
#### resource cloudflare\_list
##### required Expand Collapse
account\_id: String
The Account ID for this resource.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20account_id>)
kind: String
The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20kind>)
name: String
An informative name for the list. Use this name in filter and rule expressions.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20name>)
##### optional Expand Collapse
description?: String
An informative summary of the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20description>)
##### computed Expand Collapse
id: String
The unique ID of the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20id>)
created\_on: String
The RFC 3339 timestamp of when the list was created.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20created_on>)
modified\_on: String
The RFC 3339 timestamp of when the list was last modified.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20modified_on>)
num\_items: Float64
The number of items in the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20num_items>)
num\_referencing\_filters: Float64
The number of [filters](https://developers.cloudflare.com/api/resources/filters/) referencing the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20num_referencing_filters>)
### cloudflare\_list
Terraform
HTTPTypeScriptPythonGoTerraform
```
resource "cloudflare_list" "example_list" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
kind = "ip"
name = "list1"
description = "This is a note"
}
```
#### data cloudflare\_list
##### required Expand Collapse
list\_id: String
The unique ID of the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20list_id>)
account\_id: String
The Account ID for this resource.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20account_id>)
##### computed Expand Collapse
id: String
The unique ID of the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20id>)
created\_on: String
The RFC 3339 timestamp of when the list was created.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20created_on>)
description: String
An informative summary of the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20description>)
kind: String
The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20kind>)
modified\_on: String
The RFC 3339 timestamp of when the list was last modified.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20modified_on>)
name: String
An informative name for the list. Use this name in filter and rule expressions.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20name>)
num\_items: Float64
The number of items in the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20num_items>)
num\_referencing\_filters: Float64
The number of [filters](https://developers.cloudflare.com/api/resources/filters/) referencing the list.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20num_referencing_filters>)
### cloudflare\_list
Terraform
HTTPTypeScriptPythonGoTerraform
```
data "cloudflare_list" "example_list" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e"
}
```
#### data cloudflare\_lists
##### required Expand Collapse
account\_id: String
The Account ID for this resource.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20account_id>)
##### optional Expand Collapse
max\_items?: Int64
Max items to fetch, default: 1000
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20max_items>)
##### computed Expand Collapse
result: List\[Attributes]
The items returned by the data source
id: String
The unique ID of the list.
Link to this property
created\_on: String
The RFC 3339 timestamp of when the list was created.
Link to this property
kind: String
The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
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.
Link to this property
num\_items: Float64
The number of items in the list.
Link to this property
num\_referencing\_filters: Float64
The number of filters referencing the list.
Link to this property
description: String
An informative summary of the list.
Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20result>)
### cloudflare\_lists
Terraform
HTTPTypeScriptPythonGoTerraform
```
data "cloudflare_lists" "example_lists" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
}
```
#### Rules ListsListsItems
#### resource cloudflare\_list\_item
##### required Expand Collapse
account\_id: String
The Account ID for this resource.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20account_id>)
list\_id: String
The unique ID of the list.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20list_id>)
body: List\[Attributes]
ip?: String
An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
Link to this property
comment?: String
Defines an informative summary of the list item.
Link to this property
redirect?: Attributes
The definition of the redirect.
source\_url: String
Link to this property
target\_url: String
Link to this property
include\_subdomains?: Bool
Link to this property
preserve\_path\_suffix?: Bool
Link to this property
preserve\_query\_string?: Bool
Link to this property
status\_code?: Int64
Link to this property
subpath\_matching?: Bool
Link to this property
Link to this property
hostname?: Attributes
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?: 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
asn?: Int64
Defines a non-negative 32 bit integer.
Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20body>)
##### optional Expand Collapse
item\_id?: String
Defines the unique ID of the item in the List.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20item_id>)
##### computed Expand Collapse
asn: Int64
Defines a non-negative 32 bit integer.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20asn>)
comment: String
Defines an informative summary of the list item.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20comment>)
created\_on: String
The RFC 3339 timestamp of when the list was created.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20created_on>)
id: String
Defines the unique ID of the item in the List.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20id>)
ip: String
An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20ip>)
modified\_on: String
The RFC 3339 timestamp of when the list was last modified.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20modified_on>)
operation\_id: String
The unique operation ID of the asynchronous action.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20operation_id>)
hostname: Attributes
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: 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.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20hostname>)
redirect: Attributes
The definition of the redirect.
source\_url: String
Link to this property
target\_url: String
Link to this property
include\_subdomains: Bool
Link to this property
preserve\_path\_suffix: Bool
Link to this property
preserve\_query\_string: Bool
Link to this property
status\_code: Int64
Link to this property
subpath\_matching: Bool
Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20redirect>)
### cloudflare\_list\_item
Terraform
HTTPTypeScriptPythonGoTerraform
```
resource "cloudflare_list_item" "example_list_item" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e"
body = [{
ip = "10.0.0.1"
comment = "Private IP address"
}]
}
```
#### data cloudflare\_list\_item
##### required Expand Collapse
account\_id: String
The Account ID for this resource.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20account_id>)
item\_id: String
Defines the unique ID of the item in the List.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20item_id>)
list\_id: String
The unique ID of the list.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20list_id>)
##### computed Expand Collapse
asn: Int64
Defines a non-negative 32 bit integer.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20asn>)
comment: String
Defines an informative summary of the list item.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20comment>)
created\_on: String
The RFC 3339 timestamp of when the list was created.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20created_on>)
id: String
Defines the unique ID of the item in the List.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20id>)
ip: String
An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20ip>)
modified\_on: String
The RFC 3339 timestamp of when the list was last modified.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20modified_on>)
hostname: Attributes
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: 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.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20hostname>)
redirect: Attributes
The definition of the redirect.
source\_url: String
Link to this property
target\_url: String
Link to this property
include\_subdomains: Bool
Link to this property
preserve\_path\_suffix: Bool
Link to this property
preserve\_query\_string: Bool
Link to this property
status\_code: Int64
Link to this property
subpath\_matching: Bool
Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20redirect>)
### cloudflare\_list\_item
Terraform
HTTPTypeScriptPythonGoTerraform
```
data "cloudflare_list_item" "example_list_item" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e"
item_id = "34b12448945f11eaa1b71c4d701ab86e"
}
```
#### data cloudflare\_list\_items
##### required Expand Collapse
account\_id: String
The Account ID for this resource.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20account_id>)
list\_id: String
The unique ID of the list.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20list_id>)
##### optional Expand Collapse
per\_page?: Int64
Amount of results to include in each paginated response. A non-negative 32 bit integer.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20per_page>)
search?: String
A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20search>)
max\_items?: Int64
Max items to fetch, default: 1000
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20max_items>)
##### computed Expand Collapse
result: List\[Attributes]
The items returned by the data source
id: String
Defines the unique ID of the item in the List.
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
hostname: Attributes
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: 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
redirect: Attributes
The definition of the redirect.
source\_url: String
Link to this property
target\_url: String
Link to this property
include\_subdomains: Bool
Link to this property
preserve\_path\_suffix: Bool
Link to this property
preserve\_query\_string: Bool
Link to this property
status\_code: Int64
Link to this property
subpath\_matching: Bool
Link to this property
Link to this property
asn: Int64
Defines a non-negative 32 bit integer.
Link to this property
[Link to this property](<#(resource)%20rules.lists.items%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20result>)
### cloudflare\_list\_items
Terraform
HTTPTypeScriptPythonGoTerraform
```
data "cloudflare_list_items" "example_list_items" {
account_id = "023e105f4ecef8ad9ca31a8372d0c353"
list_id = "2c0fc9fa937b11eaa1b71c4d701ab86e"
per_page = 1
search = "1.1.1."
}
```