cloudflare/resources/radar/traffic-anomalies/traffic-anomalies.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as TrafficAnomaliesAPI from 'cloudflare/resources/radar/traffic-anomalies/traffic-anomalies';
import * as LocationsAPI from 'cloudflare/resources/radar/traffic-anomalies/locations';
export declare class TrafficAnomalies extends APIResource {
    locations: LocationsAPI.Locations;
    /**
     * Internet traffic anomalies are signals that might point to an outage, These
     * alerts are automatically detected by Radar and then manually verified by our
     * team. This endpoint returns the latest alerts.
     */
    get(query?: TrafficAnomalyGetParams, options?: Core.RequestOptions): Core.APIPromise<TrafficAnomalyGetResponse>;
    get(options?: Core.RequestOptions): Core.APIPromise<TrafficAnomalyGetResponse>;
}
export interface TrafficAnomalyGetResponse {
    trafficAnomalies: Array<TrafficAnomalyGetResponse.TrafficAnomaly>;
}
export declare namespace TrafficAnomalyGetResponse {
    interface TrafficAnomaly {
        startDate: string;
        status: string;
        type: string;
        uuid: string;
        asnDetails?: TrafficAnomaly.ASNDetails;
        endDate?: string;
        locationDetails?: TrafficAnomaly.LocationDetails;
        visibleInDataSources?: Array<string>;
    }
    namespace TrafficAnomaly {
        interface ASNDetails {
            asn: string;
            name: string;
            locations?: ASNDetails.Locations;
        }
        namespace ASNDetails {
            interface Locations {
                code: string;
                name: string;
            }
        }
        interface LocationDetails {
            code: string;
            name: string;
        }
    }
}
export interface TrafficAnomalyGetParams {
    /**
     * Single ASN as integer.
     */
    asn?: number;
    /**
     * End of the date range (inclusive).
     */
    dateEnd?: string;
    /**
     * Shorthand date ranges for the last X days - use when you don't need specific
     * start and end dates.
     */
    dateRange?: '1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl';
    /**
     * Start of the date range (inclusive).
     */
    dateStart?: string;
    /**
     * Format results are returned in.
     */
    format?: 'JSON' | 'CSV';
    /**
     * Limit the number of objects in the response.
     */
    limit?: number;
    /**
     * Location Alpha2 code.
     */
    location?: string;
    /**
     * Number of objects to skip before grabbing results.
     */
    offset?: number;
    status?: 'VERIFIED' | 'UNVERIFIED';
}
export declare namespace TrafficAnomalies {
    export import TrafficAnomalyGetResponse = TrafficAnomaliesAPI.TrafficAnomalyGetResponse;
    export import TrafficAnomalyGetParams = TrafficAnomaliesAPI.TrafficAnomalyGetParams;
    export import Locations = LocationsAPI.Locations;
    export import LocationGetResponse = LocationsAPI.LocationGetResponse;
    export import LocationGetParams = LocationsAPI.LocationGetParams;
}
//# sourceMappingURL=traffic-anomalies.d.ts.map