Locations

List Zero Trust Gateway locations

client.zeroTrust.gateway.locations.list(, ?): SinglePage<Location { id, client_default, created_at, 12 more } >

GET/accounts/{account_id}/gateway/locations

Get Zero Trust Gateway location details

client.zeroTrust.gateway.locations.get(, , ?): Location { id, client_default, created_at, 12 more }

GET/accounts/{account_id}/gateway/locations/{location_id}

Create a Zero Trust Gateway location

client.zeroTrust.gateway.locations.create(, ?): Location { id, client_default, created_at, 12 more }

POST/accounts/{account_id}/gateway/locations

Update a Zero Trust Gateway location

client.zeroTrust.gateway.locations.update(, , ?): Location { id, client_default, created_at, 12 more }

PUT/accounts/{account_id}/gateway/locations/{location_id}

Delete a Zero Trust Gateway location

client.zeroTrust.gateway.locations.delete(, , ?): LocationDeleteResponse

DELETE/accounts/{account_id}/gateway/locations/{location_id}

ModelsExpand Collapse

DOHEndpoint { enabled, networks, require_token }

enabled?: boolean

Indicate whether the DOH endpoint is enabled for this location.

networks?: Array<IPNetwork { network } > | null

Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.

network: string

Specify the IP address or IP CIDR.

require_token?: boolean

Specify whether the DOH endpoint requires user identity authentication.

DOTEndpoint { enabled, networks }

enabled?: boolean

Indicate whether the DOT endpoint is enabled for this location.

networks?: Array<IPNetwork { network } > | null

network: string

Specify the IP address or IP CIDR.

Endpoint { doh, dot, ipv4, ipv6 }

Configure the destination endpoints for this location.

doh: DOHEndpoint { enabled, networks, require_token }

dot: DOTEndpoint { enabled, networks }

ipv4: IPV4Endpoint { enabled }

ipv6: IPV6Endpoint { enabled, networks }

IPNetwork { network }

network: string

Specify the IP address or IP CIDR.

IPV4Endpoint { enabled }

enabled?: boolean

Indicate whether the IPv4 endpoint is enabled for this location.

IPV6Endpoint { enabled, networks }

enabled?: boolean

Indicate whether the IPV6 endpoint is enabled for this location.

networks?: Array<IPV6Network { network } > | null

Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.

network: string

Specify the IPv6 address or IPv6 CIDR.

IPV6Network { network }

network: string

Specify the IPv6 address or IPv6 CIDR.

Location { id, client_default, created_at, 12 more }

id?: string

client_default?: boolean

Indicate whether this location is the default location.

created_at?: string

formatdate-time

dns_destination_ips_id?: string

Indicate the identifier of the pair of IPv4 addresses assigned to this location.

dns_destination_ipv6_block_id?: string | null

Specify the UUID of the IPv6 block brought to the gateway so that this location’s IPv6 address is allocated from the Bring Your Own IPv6 (BYOIPv6) block rather than the standard Cloudflare IPv6 block.

doh_subdomain?: string

Specify the DNS over HTTPS domain that receives DNS requests. Gateway automatically generates this value.

ecs_support?: boolean

Indicate whether the location must resolve EDNS queries.

endpoints?: Endpoint { doh, dot, ipv4, ipv6 } | null

Configure the destination endpoints for this location.

ip?: string

Defines the automatically generated IPv6 destination IP assigned to this location. Gateway counts all DNS requests sent to this IP as requests under this location.

ipv4_destination?: string

Show the primary destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only.

ipv4_destination_backup?: string

Show the backup destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only.

max_ttl?: MaxTTL | null

Controls how DNS response TTLs are capped for this location relative to the account max_ttl_secs setting. Omitting max_ttl on update resets it to inherit.

mode: "inherit" | "override" | "disabled"

inherit uses the account max_ttl_secs. override uses this location’s ttl_secs. disabled leaves returned TTLs unchanged.

One of the following:

"inherit"

"override"

"disabled"

ttl_secs?: number | null

Location-specific cap on DNS response TTLs, in seconds. Required when mode is override. Must be omitted when mode is inherit or disabled.

maximum36000

minimum60

name?: string

Specify the location name.

networks?: Array<Network> | null

Specify the list of network ranges from which requests at this location originate. The list takes effect only if it is non-empty and the IPv4 endpoint is enabled for this location.

network: string

Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.

updated_at?: string

formatdate-time

LocationDeleteResponse = unknown