List proxy endpoints

client.zeroTrust.gateway.proxyEndpoints.list(, ?): SinglePage<ProxyEndpoint>

GET/accounts/{account_id}/gateway/proxy_endpoints

List all Zero Trust Gateway proxy endpoints 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

ParametersExpand Collapse

params: ProxyEndpointListParams { account_id, direction, filter, 2 more }

account_id: string

Path param

direction?: "asc" | "desc"

Query param: Sort direction. Only takes effect when order_by is also provided; it is ignored otherwise. When direction is omitted the effective direction is field-specific: created_at and updated_at default to descending (newest first); name defaults to ascending.

asc — ascending.
desc — descending.

One of the following:

"asc"

"desc"

filter?: Array<unknown>

Query param: Filter the returned proxy endpoints by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (an endpoint must satisfy every filter to be returned).

Supported fields and their matching behaviour:

name — case-insensitive substring match on the endpoint name.
id — substring match on the endpoint ID (UUID), with or without dashes.
kind — exact match on the endpoint kind. The value must be ip or identity; any other value returns 400.

Each entry must match one of the per-field patterns below: the field must be one of name, id, or kind; name/id accept any value, while kind only accepts ip or identity.

order_by?: "name" | "created_at" | "updated_at"

Query param: Field to sort the returned endpoints by. When omitted, the order of results is unspecified. Supported values:

name — sort alphabetically by endpoint name.
created_at — sort by creation time; defaults to descending unless direction is set.
updated_at — sort by last-modified time; defaults to descending unless direction is set.

One of the following:

"name"

"created_at"

"updated_at"

search?: string

Query param: Case-insensitive substring match on the endpoint name. When combined with filter, both must match (logical AND).

ReturnsExpand Collapse

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

List proxy endpoints

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 proxyEndpoint of client.zeroTrust.gateway.proxyEndpoints.list({
  account_id: '699d98642c564d2e855e9661899b7252',
})) {
  console.log(proxyEndpoint);
}

{
  "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": [
    {
      "ips": [
        "192.0.2.1/32"
      ],
      "name": "Devops team",
      "id": "ed35569b41ce4d1facfe683550f54086",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "kind": "ip",
      "subdomain": "oli3n9zkz5.proxy.cloudflare-gateway.com",
      "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": [
    {
      "ips": [
        "192.0.2.1/32"
      ],
      "name": "Devops team",
      "id": "ed35569b41ce4d1facfe683550f54086",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "kind": "ip",
      "subdomain": "oli3n9zkz5.proxy.cloudflare-gateway.com",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}