--- title: Create a list --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Rules Lists](https://developers.cloudflare.com/api/python/resources/rules) [Lists](https://developers.cloudflare.com/api/python/resources/rules/subresources/lists) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a list rules.lists.create(ListCreateParams\*\*kwargs) -> [ListCreateResponse]() POST/accounts/{account\_id}/rules/lists Creates a new list of the specified kind. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Account Filter Lists Edit` ##### ParametersExpand Collapse account\_id: str The Account ID for this resource. maxLength32 minLength32 [Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
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](<#(resource)%20rules.lists%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20kind%20%3E%20(schema)>) name: str An informative name for the list. Use this name in filter and rule expressions. maxLength50 [Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>) description: Optional\[str] An informative summary of the list. maxLength500 [Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20description%20%3E%20(schema)>) ##### ReturnsExpand Collapse
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)>) ### Create a list Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) list = client.rules.lists.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", kind="ip", name="list1", ) print(list.id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "2c0fc9fa937b11eaa1b71c4d701ab86e", "created_on": "2020-01-01T08:00:00Z", "kind": "ip", "modified_on": "2020-01-10T14:00:00Z", "name": "list1", "num_items": 10, "num_referencing_filters": 2, "description": "This is a note" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "2c0fc9fa937b11eaa1b71c4d701ab86e", "created_on": "2020-01-01T08:00:00Z", "kind": "ip", "modified_on": "2020-01-10T14:00:00Z", "name": "list1", "num_items": 10, "num_referencing_filters": 2, "description": "This is a note" }, "success": true } ```