List device ISPs

client.zeroTrust.dex.devices.isps.list(, , ?): V4PagePagination<ISPs { isps } >

GET/accounts/{account_id}/dex/devices/{device_id}/isps

List ISP information observed for a specific device during traceroute tests.

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 DEX WriteCloudflare DEX ReadZero Trust ReportZero Trust Read

ParametersExpand Collapse

deviceId: string

API Resource UUID tag.

maxLength36

params: ISPListParams { account_id, per_page, cursor, 5 more }

account_id: string

Path param: Unique identifier linked to an account.

maxLength32

per_page: number

Query param: Number of items per page

maximum50

minimum1

cursor?: string

Query param: Cursor for cursor-based pagination. Mutually exclusive with page.

from?: string

Query param: Start time for the query in ISO 8601 format.

formatdate-time

page?: number

Query param: Page number of paginated results. Mutually exclusive with cursor.

minimum1

sort_by?: "time_start"

Query param: The field to sort results by.

sort_order?: "ASC" | "DESC"

Query param: The order to sort results.

One of the following:

"ASC"

"DESC"

to?: string

Query param: End time for the query in ISO 8601 format.

formatdate-time

ReturnsExpand Collapse

ISPs { isps }

isps: Array<ISP>

test_id: string

The test that generated this result.

test_result_id: string

The specific test result.

time_start: string

Timestamp of when the ISP was observed.

formatdate-time

ip?: IP { address, asn, aso, 4 more }

IP address information for the ISP hop. Fields marked as PII-gated (name, address, netmask, and all location sub-fields) will be returned as the literal string "REDACTED" for callers that do not have the PII permission. asn, aso, and version are always returned regardless of PII access.

address?: string

IP address. Returned as "REDACTED" without PII permission.

asn?: number

Autonomous System Number.

aso?: string

Autonomous System Organization name.

location?: Location { city, country_iso, state_iso, zip }

Geographic location information. All fields are returned as the literal string "REDACTED" for callers that do not have the PII permission.

city?: string

City name. Returned as "REDACTED" without PII permission.

country_iso?: string

Country ISO code. Returned as "REDACTED" without PII permission.

state_iso?: string

State/province ISO code. Returned as "REDACTED" without PII permission.

zip?: string

ZIP/postal code. Returned as "REDACTED" without PII permission.

name?: string

Named IP address (reverse DNS hostname when available). Returned as "REDACTED" without PII permission.

netmask?: string

Network mask. Returned as "REDACTED" without PII permission.

version?: number

IP version (1 for IPv4, 2 for IPv6, 0 if unknown).

List device ISPs

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 isps of client.zeroTrust.dex.devices.isps.list(
  'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
  { account_id: '01a7362d577a6c3019a474fd6f485823', per_page: 10 },
)) {
  console.log(isps.isps);
}

{
  "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": {
    "isps": [
      {
        "test_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "test_result_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "time_start": "2024-06-01T12:00:00Z",
        "ip": {
          "address": "203.0.113.1",
          "asn": 13335,
          "aso": "CLOUDFLARENET",
          "location": {
            "city": "San Francisco",
            "country_iso": "US",
            "state_iso": "CA",
            "zip": "94107"
          },
          "name": "isp-gateway.example.com",
          "netmask": "255.255.255.0",
          "version": 1
        }
      }
    ]
  },
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

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": {
    "isps": [
      {
        "test_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "test_result_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "time_start": "2024-06-01T12:00:00Z",
        "ip": {
          "address": "203.0.113.1",
          "asn": 13335,
          "aso": "CLOUDFLARENET",
          "location": {
            "city": "San Francisco",
            "country_iso": "US",
            "state_iso": "CA",
            "zip": "94107"
          },
          "name": "isp-gateway.example.com",
          "netmask": "255.255.255.0",
          "version": 1
        }
      }
    ]
  },
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}