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

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

Get a list item

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

Create list items

POST/accounts/{account_id}/rules/lists/{list_id}/items

Update all list items

PUT/accounts/{account_id}/rules/lists/{list_id}/items

Delete list items

DELETE/accounts/{account_id}/rules/lists/{list_id}/items

ModelsExpand Collapse

ListCursor object { after, before }

after: optional string

before: optional string

ListItem object { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.

ItemListResponse = object { id, created_on, ip, 2 more } or object { id, created_on, hostname, 2 more } or object { id, created_on, modified_on, 2 more } or object { id, asn, created_on, 2 more }

One of the following:

ListsListItemIPFull object { 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: optional string

Defines an informative summary of the list item.

ListsListItemHostnameFull object { 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: optional string

Defines an informative summary of the list item.

ListsListItemRedirectFull object { 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: optional string

Defines an informative summary of the list item.

ListsListItemASNFull object { 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: optional string

Defines an informative summary of the list item.

ItemGetResponse = object { id, created_on, ip, 2 more } or object { id, created_on, hostname, 2 more } or object { id, created_on, modified_on, 2 more } or object { id, asn, created_on, 2 more }

One of the following:

ListsListItemIPFull object { 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: optional string

Defines an informative summary of the list item.

ListsListItemHostnameFull object { 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: optional string

Defines an informative summary of the list item.

ListsListItemRedirectFull object { 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: optional string

Defines an informative summary of the list item.

ListsListItemASNFull object { 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: optional string

Defines an informative summary of the list item.

ItemCreateResponse object { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.

ItemUpdateResponse object { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.

ItemDeleteResponse object { operation_id }

operation_id: string

The unique operation ID of the asynchronous action.