cloudflare/resources/zero-trust/dex/traceroute-test-results/network-path.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as NetworkPathAPI from 'cloudflare/resources/zero-trust/dex/traceroute-test-results/network-path';
export declare class NetworkPath extends APIResource {
    /**
     * Get a breakdown of hops and performance metrics for a specific traceroute test
     * run
     */
    get(testResultId: string, params: NetworkPathGetParams, options?: Core.RequestOptions): Core.APIPromise<DigitalExperienceMonitoringTracerouteTestResultNetworkPath>;
}
export interface DigitalExperienceMonitoringTracerouteTestResultNetworkPath {
    /**
     * an array of the hops taken by the device to reach the end destination
     */
    hops: Array<DigitalExperienceMonitoringTracerouteTestResultNetworkPath.Hop>;
    /**
     * API Resource UUID tag.
     */
    resultId: string;
    /**
     * date time of this traceroute test
     */
    time_start: string;
    /**
     * name of the device associated with this network path response
     */
    deviceName?: string;
    /**
     * API Resource UUID tag.
     */
    testId?: string;
    /**
     * name of the tracroute test
     */
    testName?: string;
}
export declare namespace DigitalExperienceMonitoringTracerouteTestResultNetworkPath {
    interface Hop {
        ttl: number;
        asn?: number | null;
        aso?: string | null;
        ipAddress?: string | null;
        location?: Hop.Location | null;
        mile?: 'client-to-app' | 'client-to-cf-egress' | 'client-to-cf-ingress' | 'client-to-isp' | null;
        name?: string | null;
        packetLossPct?: number | null;
        rttMs?: number | null;
    }
    namespace Hop {
        interface Location {
            city?: string | null;
            state?: string | null;
            zip?: string | null;
        }
    }
}
export interface NetworkPathGetParams {
    /**
     * unique identifier linked to an account
     */
    account_id: string;
}
export declare namespace NetworkPath {
    export import DigitalExperienceMonitoringTracerouteTestResultNetworkPath = NetworkPathAPI.DigitalExperienceMonitoringTracerouteTestResultNetworkPath;
    export import NetworkPathGetParams = NetworkPathAPI.NetworkPathGetParams;
}
//# sourceMappingURL=network-path.d.ts.map