API Reference

Rules Lists

Lists

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Items

Get list items

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

client.rules.lists.items.get(stringlistId, stringitemId, ItemGetParams { account_id } params, RequestOptionsoptions?): ItemGetResponse

GET/accounts/{account_id}/rules/lists/{list_id}/items/{item_id}

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

Update all list items

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

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

before?: string

ListItem { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.

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

created_on: string

The RFC 3339 timestamp of when the list was created.

ip: string

An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

comment?: string

Defines an informative summary of the list item.

ListsListItemHostnameFull { id, created_on, hostname, 2 more }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

hostname: Hostname { url_hostname, exclude_exact_hostname }

Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

comment?: string

Defines an informative summary of the list item.

ListsListItemRedirectFull { id, created_on, modified_on, 2 more }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

redirect: Redirect { source_url, target_url, include_subdomains, 4 more }

The definition of the redirect.

comment?: string

Defines an informative summary of the list item.

ListsListItemASNFull { id, asn, created_on, 2 more }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

asn: number

Defines a non-negative 32 bit integer.

created_on: string

The RFC 3339 timestamp of when the list was created.

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

comment?: string

Defines an informative summary of the list item.

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 }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

ip: string

An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

comment?: string

Defines an informative summary of the list item.

ListsListItemHostnameFull { id, created_on, hostname, 2 more }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

hostname: Hostname { url_hostname, exclude_exact_hostname }

Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

comment?: string

Defines an informative summary of the list item.

ListsListItemRedirectFull { id, created_on, modified_on, 2 more }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

redirect: Redirect { source_url, target_url, include_subdomains, 4 more }

The definition of the redirect.

comment?: string

Defines an informative summary of the list item.

ListsListItemASNFull { id, asn, created_on, 2 more }

id: string

Defines the unique ID of the item in the List.

maxLength32

minLength32

asn: number

Defines a non-negative 32 bit integer.

created_on: string

The RFC 3339 timestamp of when the list was created.

modified_on: string

The RFC 3339 timestamp of when the list was last modified.

comment?: string

Defines an informative summary of the list item.

ItemCreateResponse { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.

ItemUpdateResponse { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.

ItemDeleteResponse { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.