Skip to content
Start here

Proxy Endpoints

List proxy endpoints
client.zeroTrust.gateway.proxyEndpoints.list(ProxyEndpointListParams { account_id } params, RequestOptionsoptions?): SinglePage<ProxyEndpoint>
GET/accounts/{account_id}/gateway/proxy_endpoints
Get a proxy endpoint
client.zeroTrust.gateway.proxyEndpoints.get(stringproxyEndpointId, ProxyEndpointGetParams { account_id } params, RequestOptionsoptions?): ProxyEndpoint
GET/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
Create a proxy endpoint
client.zeroTrust.gateway.proxyEndpoints.create(ProxyEndpointCreateParamsparams, RequestOptionsoptions?): ProxyEndpoint
POST/accounts/{account_id}/gateway/proxy_endpoints
Update a proxy endpoint
client.zeroTrust.gateway.proxyEndpoints.edit(stringproxyEndpointId, ProxyEndpointEditParams { account_id, ips, name } params, RequestOptionsoptions?): ProxyEndpoint
PATCH/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
Delete a proxy endpoint
client.zeroTrust.gateway.proxyEndpoints.delete(stringproxyEndpointId, ProxyEndpointDeleteParams { account_id } params, RequestOptionsoptions?): ProxyEndpointDeleteResponse
DELETE/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}
ModelsExpand Collapse
GatewayIPs = string

Specify an IPv4 or IPv6 CIDR. Limit IPv6 to a maximum of /109 and IPv4 to a maximum of /25.

ProxyEndpoint = ZeroTrustGatewayProxyEndpointIP { ips, name, id, 4 more } | ZeroTrustGatewayProxyEndpointIdentity { kind, name, id, 3 more }
One of the following:
ZeroTrustGatewayProxyEndpointIP { ips, name, id, 4 more }
ips: Array<GatewayIPs>

Specify the list of CIDRs to restrict ingress connections.

name: string

Specify the name of the proxy endpoint.

id?: string
created_at?: string
formatdate-time
kind?: "ip"

The proxy endpoint kind

subdomain?: string

Specify the subdomain to use as the destination in the proxy client.

updated_at?: string
formatdate-time
ZeroTrustGatewayProxyEndpointIdentity { kind, name, id, 3 more }
kind: "identity"

The proxy endpoint kind

name: string

Specify the name of the proxy endpoint.

id?: string
created_at?: string
formatdate-time
subdomain?: string

Specify the subdomain to use as the destination in the proxy client.

updated_at?: string
formatdate-time
ProxyEndpointDeleteResponse = unknown