API Reference

Zero Trust

Gateway

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Lists

List Zero Trust lists

client.zeroTrust.gateway.lists.list(ListListParams { account_id, type } params, RequestOptionsoptions?): SinglePage<GatewayList { id, count, created_at, 5 more } >

GET/accounts/{account_id}/gateway/lists

Get Zero Trust list details

client.zeroTrust.gateway.lists.get(stringlistId, ListGetParams { account_id } params, RequestOptionsoptions?): GatewayList { id, count, created_at, 5 more }

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

Create Zero Trust list

client.zeroTrust.gateway.lists.create(ListCreateParams { account_id, name, type, 2 more } params, RequestOptionsoptions?): ListCreateResponse { id, created_at, description, 4 more }

POST/accounts/{account_id}/gateway/lists

Update Zero Trust list

client.zeroTrust.gateway.lists.update(stringlistId, ListUpdateParams { account_id, name, description, items } params, RequestOptionsoptions?): GatewayList { id, count, created_at, 5 more }

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

Patch Zero Trust list.

client.zeroTrust.gateway.lists.edit(stringlistId, ListEditParams { account_id, append, remove } params, RequestOptionsoptions?): GatewayList { id, count, created_at, 5 more }

PATCH/accounts/{account_id}/gateway/lists/{list_id}

Delete Zero Trust list

client.zeroTrust.gateway.lists.delete(stringlistId, ListDeleteParams { account_id } params, RequestOptionsoptions?): ListDeleteResponse

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

ModelsExpand Collapse

GatewayItem { created_at, description, value }

created_at?: string

formatdate-time

description?: string

Provide the list item description (optional).

minimum0

value?: string

Specify the item value.

GatewayList { id, count, created_at, 5 more }

id?: string

Identify the API resource with a UUID.

maxLength36

count?: number

Indicate the number of items in the list.

created_at?: string

formatdate-time

description?: string

Provide the list description.

items?: Array<GatewayItem { created_at, description, value } >

Provide the list items.

created_at?: string

formatdate-time

description?: string

Provide the list item description (optional).

minimum0

value?: string

Specify the item value.

name?: string

Specify the list name.

type?: "SERIAL" | "URL" | "DOMAIN" | 6 more

Specify the list type.

One of the following:

"SERIAL"

"URL"

"DOMAIN"

"EMAIL"

"IP"

"CATEGORY"

"LOCATION"

"DEVICE"

"AAGUID"

updated_at?: string

formatdate-time

ListCreateResponse { id, created_at, description, 4 more }

id?: string

Identify the API resource with a UUID.

maxLength36

created_at?: string

formatdate-time

description?: string

Provide the list description.

items?: Array<GatewayItem { created_at, description, value } >

Provide the list items.

created_at?: string

formatdate-time

description?: string

Provide the list item description (optional).

minimum0

value?: string

Specify the item value.

name?: string

Specify the list name.

type?: "SERIAL" | "URL" | "DOMAIN" | 6 more

Specify the list type.

One of the following:

"SERIAL"

"URL"

"DOMAIN"

"EMAIL"

"IP"

"CATEGORY"

"LOCATION"

"DEVICE"

"AAGUID"

updated_at?: string

formatdate-time

ListDeleteResponse = unknown

ListsItems

Get Zero Trust list items

client.zeroTrust.gateway.lists.items.list(stringlistId, ItemListParams { account_id } params, RequestOptionsoptions?): SinglePage<ItemListResponse { created_at, description, value } >

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

ModelsExpand Collapse

ItemListResponse = Array<GatewayItem { created_at, description, value } >

Provide the list items.

created_at?: string

formatdate-time

description?: string

Provide the list item description (optional).

minimum0

value?: string

Specify the item value.