--- title: Create list items --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Rules Lists](https://developers.cloudflare.com/api/typescript/resources/rules) [Lists](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists) [Items](https://developers.cloudflare.com/api/typescript/resources/rules/subresources/lists/subresources/items) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create list items client.rules.lists.items.create(stringlistID, ItemCreateParams {account\_id, body } params, RequestOptionsoptions?): [ItemCreateResponse]() {operation\_id } POST/accounts/{account\_id}/rules/lists/{list\_id}/items Appends new items to the list. This operation is asynchronous. To get the current operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`. There is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected. ##### 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 listID: string The unique ID of the list. maxLength32 minLength32 [Link to this property](<#(resource)%20rules.lists.items%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20list_id%20%3E%20(schema)>)

params: ItemCreateParams {account\_id, body }

account\_id: string Path param: The Account ID for this resource. maxLength32 minLength32 Link to this property

body: Array<ListsListItemIPComment {ip, comment } | ListsListItemRedirectComment {redirect, comment } | ListsListItemHostnameComment {hostname, comment } | ListsListItemASNComment {asn, comment } > Body param

One of the following:

ListsListItemIPComment {ip, comment }

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

Link to this property

ListsListItemRedirectComment {redirect, comment }

redirect: 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 comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemHostnameComment {hostname, comment }

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 (-).

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 comment?: string Defines an informative summary of the list item. Link to this property

Link to this property

ListsListItemASNComment {asn, comment }

asn: number Defines a non-negative 32 bit integer. 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(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

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)>) ### Create list items TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const item = await client.rules.lists.items.create('2c0fc9fa937b11eaa1b71c4d701ab86e', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', body: [{ ip: '10.0.0.1' }], }); console.log(item.operation_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": { "operation_id": "4da8780eeb215e6cb7f48dd981c4ea02" }, "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": { "operation_id": "4da8780eeb215e6cb7f48dd981c4ea02" }, "success": true } ```