API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules Lists

Rules ListsLists

Get lists

GET/accounts/{account_id}/rules/lists

Get a list

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

Create a list

POST/accounts/{account_id}/rules/lists

Update a list

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

Delete a list

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

ModelsExpand Collapse

Hostname object { 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 (-).

url_hostname: string

exclude_exact_hostname: optional boolean

Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.

ListsList object { id, created_on, kind, 5 more }

id: string

The unique ID of the list.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

kind: "ip" or "redirect" or "hostname" or "asn"

The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).

One of the following:

"ip"

"redirect"

"hostname"

"asn"

modified_on: string

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

name: string

An informative name for the list. Use this name in filter and rule expressions.

maxLength50

num_items: number

The number of items in the list.

num_referencing_filters: number

The number of filters referencing the list.

description: optional string

An informative summary of the list.

maxLength500

Redirect object { source_url, target_url, include_subdomains, 4 more }

The definition of the redirect.

source_url: string

target_url: string

include_subdomains: optional boolean

preserve_path_suffix: optional boolean

preserve_query_string: optional boolean

status_code: optional 301 or 302 or 307 or 308

One of the following:

301

302

307

308

subpath_matching: optional boolean

ListGetResponse object { id, created_on, kind, 5 more }

id: string

The unique ID of the list.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

kind: "ip" or "redirect" or "hostname" or "asn"

The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).

One of the following:

"ip"

"redirect"

"hostname"

"asn"

modified_on: string

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

name: string

An informative name for the list. Use this name in filter and rule expressions.

maxLength50

num_items: number

The number of items in the list.

num_referencing_filters: number

The number of filters referencing the list.

description: optional string

An informative summary of the list.

maxLength500

ListCreateResponse object { id, created_on, kind, 5 more }

id: string

The unique ID of the list.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

kind: "ip" or "redirect" or "hostname" or "asn"

The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).

One of the following:

"ip"

"redirect"

"hostname"

"asn"

modified_on: string

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

name: string

An informative name for the list. Use this name in filter and rule expressions.

maxLength50

num_items: number

The number of items in the list.

num_referencing_filters: number

The number of filters referencing the list.

description: optional string

An informative summary of the list.

maxLength500

ListUpdateResponse object { id, created_on, kind, 5 more }

id: string

The unique ID of the list.

maxLength32

minLength32

created_on: string

The RFC 3339 timestamp of when the list was created.

kind: "ip" or "redirect" or "hostname" or "asn"

The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).

One of the following:

"ip"

"redirect"

"hostname"

"asn"

modified_on: string

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

name: string

An informative name for the list. Use this name in filter and rule expressions.

maxLength50

num_items: number

The number of items in the list.

num_referencing_filters: number

The number of filters referencing the list.

description: optional string

An informative summary of the list.

maxLength500

ListDeleteResponse object { id }

id: string

The unique ID of the list.

maxLength32

minLength32

Rules ListsListsBulk Operations

Get bulk operation status

GET/accounts/{account_id}/rules/lists/bulk_operations/{operation_id}

ModelsExpand Collapse

BulkOperationGetResponse = object { id, status } or object { id, completed, status } or object { id, completed, error, status }

One of the following:

ListsBulkOperationPendingOrRunning object { id, status }

id: string

The unique operation ID of the asynchronous action.

status: "pending" or "running"

The current status of the asynchronous operation.

One of the following:

"pending"

"running"

ListsBulkOperationCompleted object { id, completed, status }

id: string

The unique operation ID of the asynchronous action.

completed: string

The RFC 3339 timestamp of when the operation was completed.

status: "completed"

The current status of the asynchronous operation.

ListsBulkOperationFailed object { id, completed, error, status }

id: string

The unique operation ID of the asynchronous action.

completed: string

The RFC 3339 timestamp of when the operation was completed.

error: string

A message describing the error when the status is failed.

status: "failed"

The current status of the asynchronous operation.

Rules ListsListsItems

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 = unknown

ItemGetResponse = unknown

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.