List Zero Trust Gateway locations

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

GET/accounts/{account_id}/gateway/locations

List Zero Trust Gateway locations for an account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloudflare Zero Trust Secure DNS Locations WriteZero Trust ReadZero Trust Write

ParametersExpand Collapse

params: LocationListParams { account_id }

account_id: string

ReturnsExpand Collapse

Location { id, client_default, created_at, 11 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.

doh: 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.

dot: 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.

ipv4: IPV4Endpoint { enabled }

enabled?: boolean

Indicate whether the IPv4 endpoint is enabled for this location.

ipv6: 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.

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.

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

List Zero Trust Gateway locations

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const location of client.zeroTrust.gateway.locations.list({
  account_id: '699d98642c564d2e855e9661899b7252',
})) {
  console.log(location.id);
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "ed35569b41ce4d1facfe683550f54086",
      "client_default": false,
      "created_at": "2014-01-01T05:20:00.12345Z",
      "dns_destination_ips_id": "0e4a32c6-6fb8-4858-9296-98f51631e8e6",
      "dns_destination_ipv6_block_id": "b08f7231-d458-495c-98ef-190604c9ee83",
      "doh_subdomain": "oli3n9zkz5",
      "ecs_support": false,
      "endpoints": {
        "doh": {
          "enabled": true,
          "networks": [
            {
              "network": "2001:85a3::/64"
            }
          ],
          "require_token": true
        },
        "dot": {
          "enabled": true,
          "networks": [
            {
              "network": "2001:85a3::/64"
            }
          ]
        },
        "ipv4": {
          "enabled": true
        },
        "ipv6": {
          "enabled": true,
          "networks": [
            {
              "network": "2001:85a3::/64"
            }
          ]
        }
      },
      "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "ipv4_destination": "172.64.36.1",
      "ipv4_destination_backup": "172.64.36.2",
      "name": "Austin Office Location",
      "networks": [
        {
          "network": "192.0.2.1/32"
        }
      ],
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "ed35569b41ce4d1facfe683550f54086",
      "client_default": false,
      "created_at": "2014-01-01T05:20:00.12345Z",
      "dns_destination_ips_id": "0e4a32c6-6fb8-4858-9296-98f51631e8e6",
      "dns_destination_ipv6_block_id": "b08f7231-d458-495c-98ef-190604c9ee83",
      "doh_subdomain": "oli3n9zkz5",
      "ecs_support": false,
      "endpoints": {
        "doh": {
          "enabled": true,
          "networks": [
            {
              "network": "2001:85a3::/64"
            }
          ],
          "require_token": true
        },
        "dot": {
          "enabled": true,
          "networks": [
            {
              "network": "2001:85a3::/64"
            }
          ]
        },
        "ipv4": {
          "enabled": true
        },
        "ipv6": {
          "enabled": true,
          "networks": [
            {
              "network": "2001:85a3::/64"
            }
          ]
        }
      },
      "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "ipv4_destination": "172.64.36.1",
      "ipv4_destination_backup": "172.64.36.2",
      "name": "Austin Office Location",
      "networks": [
        {
          "network": "192.0.2.1/32"
        }
      ],
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}