Skip to content
Cloudflare API
Start here
API Reference
Rules Lists
Lists

Items

Get list items
rules.lists.items.list(strlist_id, ItemListParams**kwargs) -> SyncCursorPaginationAfter[ItemListResponse]
GET/accounts/{account_id}/rules/lists/{list_id}/items
Get a list item
rules.lists.items.get(stritem_id, ItemGetParams**kwargs) -> ItemGetResponse
GET/accounts/{account_id}/rules/lists/{list_id}/items/{item_id}
Create list items
rules.lists.items.create(strlist_id, ItemCreateParams**kwargs) -> ItemCreateResponse
POST/accounts/{account_id}/rules/lists/{list_id}/items
Update all list items
rules.lists.items.update(strlist_id, ItemUpdateParams**kwargs) -> ItemUpdateResponse
PUT/accounts/{account_id}/rules/lists/{list_id}/items
Delete list items
rules.lists.items.delete(strlist_id, ItemDeleteParams**kwargs) -> ItemDeleteResponse
DELETE/accounts/{account_id}/rules/lists/{list_id}/items
ModelsExpand Collapse
class ListCursor: …
after: Optional[str]
before: Optional[str]
class ListItem: …
operation_id: str

The unique operation ID of the asynchronous action.

One of the following:
class ListsListItemIPFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
created_on: str

The RFC 3339 timestamp of when the list was created.

ip: str

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

modified_on: str

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

comment: Optional[str]

Defines an informative summary of the list item.

class ListsListItemHostnameFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
created_on: str

The RFC 3339 timestamp of when the list was created.

hostname: 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: str

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

comment: Optional[str]

Defines an informative summary of the list item.

class ListsListItemRedirectFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
created_on: str

The RFC 3339 timestamp of when the list was created.

modified_on: str

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

redirect: Redirect

The definition of the redirect.

comment: Optional[str]

Defines an informative summary of the list item.

class ListsListItemASNFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
asn: int

Defines a non-negative 32 bit integer.

created_on: str

The RFC 3339 timestamp of when the list was created.

modified_on: str

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

comment: Optional[str]

Defines an informative summary of the list item.

One of the following:
class ListsListItemIPFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
created_on: str

The RFC 3339 timestamp of when the list was created.

ip: str

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

modified_on: str

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

comment: Optional[str]

Defines an informative summary of the list item.

class ListsListItemHostnameFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
created_on: str

The RFC 3339 timestamp of when the list was created.

hostname: 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: str

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

comment: Optional[str]

Defines an informative summary of the list item.

class ListsListItemRedirectFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
created_on: str

The RFC 3339 timestamp of when the list was created.

modified_on: str

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

redirect: Redirect

The definition of the redirect.

comment: Optional[str]

Defines an informative summary of the list item.

class ListsListItemASNFull: …
id: str

Defines the unique ID of the item in the List.

maxLength32
minLength32
asn: int

Defines a non-negative 32 bit integer.

created_on: str

The RFC 3339 timestamp of when the list was created.

modified_on: str

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

comment: Optional[str]

Defines an informative summary of the list item.

class ItemCreateResponse: …
operation_id: str

The unique operation ID of the asynchronous action.

class ItemUpdateResponse: …
operation_id: str

The unique operation ID of the asynchronous action.

class ItemDeleteResponse: …
operation_id: str

The unique operation ID of the asynchronous action.