Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Gateway

Lists

List Zero Trust lists
zero_trust.gateway.lists.list(ListListParams**kwargs) -> SyncSinglePage[GatewayList]
GET/accounts/{account_id}/gateway/lists
Get Zero Trust list details
zero_trust.gateway.lists.get(strlist_id, ListGetParams**kwargs) -> GatewayList
GET/accounts/{account_id}/gateway/lists/{list_id}
Create Zero Trust list
zero_trust.gateway.lists.create(ListCreateParams**kwargs) -> ListCreateResponse
POST/accounts/{account_id}/gateway/lists
Update Zero Trust list
zero_trust.gateway.lists.update(strlist_id, ListUpdateParams**kwargs) -> GatewayList
PUT/accounts/{account_id}/gateway/lists/{list_id}
Patch Zero Trust list.
zero_trust.gateway.lists.edit(strlist_id, ListEditParams**kwargs) -> GatewayList
PATCH/accounts/{account_id}/gateway/lists/{list_id}
Delete Zero Trust list
zero_trust.gateway.lists.delete(strlist_id, ListDeleteParams**kwargs) -> object
DELETE/accounts/{account_id}/gateway/lists/{list_id}
ModelsExpand Collapse
class GatewayItem: …
created_at: Optional[datetime]
formatdate-time
description: Optional[str]

Provide the list item description (optional).

minimum0
value: Optional[str]

Specify the item value.

class GatewayList: …
id: Optional[str]

Identify the API resource with a UUID.

maxLength36
count: Optional[float]

Indicate the number of items in the list.

created_at: Optional[datetime]
formatdate-time
description: Optional[str]

Provide the list description.

items: Optional[List[GatewayItem]]

Provide the list items.

created_at: Optional[datetime]
formatdate-time
description: Optional[str]

Provide the list item description (optional).

minimum0
value: Optional[str]

Specify the item value.

name: Optional[str]

Specify the list name.

type: Optional[Literal["SERIAL", "URL", "DOMAIN", 5 more]]

Specify the list type.

One of the following:
"SERIAL"
"URL"
"DOMAIN"
"EMAIL"
"IP"
"CATEGORY"
"LOCATION"
"DEVICE"
updated_at: Optional[datetime]
formatdate-time
class ListCreateResponse: …
id: Optional[str]

Identify the API resource with a UUID.

maxLength36
created_at: Optional[datetime]
formatdate-time
description: Optional[str]

Provide the list description.

items: Optional[List[GatewayItem]]

Provide the list items.

created_at: Optional[datetime]
formatdate-time
description: Optional[str]

Provide the list item description (optional).

minimum0
value: Optional[str]

Specify the item value.

name: Optional[str]

Specify the list name.

type: Optional[Literal["SERIAL", "URL", "DOMAIN", 5 more]]

Specify the list type.

One of the following:
"SERIAL"
"URL"
"DOMAIN"
"EMAIL"
"IP"
"CATEGORY"
"LOCATION"
"DEVICE"
updated_at: Optional[datetime]
formatdate-time

ListsItems

Get Zero Trust list items
zero_trust.gateway.lists.items.list(strlist_id, ItemListParams**kwargs) -> SyncSinglePage[ItemListResponse]
GET/accounts/{account_id}/gateway/lists/{list_id}/items
ModelsExpand Collapse
List[GatewayItem]

Provide the list items.

created_at: Optional[datetime]
formatdate-time
description: Optional[str]

Provide the list item description (optional).

minimum0
value: Optional[str]

Specify the item value.