cloudflare/resources/radar/bgp/leaks/events.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as EventsAPI from 'cloudflare/resources/radar/bgp/leaks/events';
import { V4PagePagination, type V4PagePaginationParams } from 'cloudflare/pagination';
export declare class Events extends APIResource {
    /**
     * Get the BGP route leak events (Beta).
     */
    list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventListResponsesV4PagePagination, EventListResponse>;
    list(options?: Core.RequestOptions): Core.PagePromise<EventListResponsesV4PagePagination, EventListResponse>;
}
export declare class EventListResponsesV4PagePagination extends V4PagePagination<EventListResponse> {
}
export interface EventListResponse {
    result: EventListResponse.Result;
    result_info: EventListResponse.ResultInfo;
    success: boolean;
}
export declare namespace EventListResponse {
    interface Result {
        asn_info: Array<Result.ASNInfo>;
        events: Array<Result.Event>;
    }
    namespace Result {
        interface ASNInfo {
            asn: number;
            country_code: string;
            org_name: string;
        }
        interface Event {
            id: number;
            countries: Array<string>;
            detected_ts: string;
            finished: boolean;
            leak_asn: number;
            leak_count: number;
            leak_seg: Array<number>;
            leak_type: number;
            max_ts: string;
            min_ts: string;
            origin_count: number;
            peer_count: number;
            prefix_count: number;
        }
    }
    interface ResultInfo {
        count: number;
        page: number;
        per_page: number;
        total_count: number;
    }
}
export interface EventListParams extends V4PagePaginationParams {
    /**
     * 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;
    /**
     * The unique identifier of a event
     */
    eventId?: number;
    /**
     * Format results are returned in.
     */
    format?: 'JSON' | 'CSV';
    /**
     * ASN that is causing or affected by a route leak event
     */
    involvedAsn?: number;
    /**
     * Country code of a involved ASN in a route leak event
     */
    involvedCountry?: string;
    /**
     * The leaking AS of a route leak event
     */
    leakAsn?: number;
    /**
     * Sort events by field
     */
    sortBy?: 'ID' | 'LEAKS' | 'PEERS' | 'PREFIXES' | 'ORIGINS' | 'TIME';
    /**
     * Sort order
     */
    sortOrder?: 'ASC' | 'DESC';
}
export declare namespace Events {
    export import EventListResponse = EventsAPI.EventListResponse;
    export import EventListResponsesV4PagePagination = EventsAPI.EventListResponsesV4PagePagination;
    export import EventListParams = EventsAPI.EventListParams;
}
//# sourceMappingURL=events.d.ts.map