cloudflare/resources/radar/bgp/hijacks.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as HijacksAPI from 'cloudflare/resources/radar/bgp/hijacks';
export declare class Hijacks extends APIResource {
    /**
     * Get the BGP hijack events. (Beta)
     */
    events(query?: HijackEventsParams, options?: Core.RequestOptions): Core.APIPromise<HijackEventsResponse>;
    events(options?: Core.RequestOptions): Core.APIPromise<HijackEventsResponse>;
}
export interface HijackEventsResponse {
    asn_info: Array<HijackEventsResponse.ASNInfo>;
    events: Array<HijackEventsResponse.Event>;
    total_monitors: number;
}
export declare namespace HijackEventsResponse {
    interface ASNInfo {
        asn: number;
        country_code: string;
        org_name: string;
    }
    interface Event {
        id: number;
        confidence_score: number;
        duration: number;
        event_type: number;
        hijack_msgs_count: number;
        hijacker_asn: number;
        hijacker_country: string;
        is_stale: boolean;
        max_hijack_ts: string;
        max_msg_ts: string;
        min_hijack_ts: string;
        on_going_count: number;
        peer_asns: Array<number>;
        peer_ip_count: number;
        prefixes: Array<string>;
        tags: Array<Event.Tag>;
        victim_asns: Array<number>;
        victim_countries: Array<string>;
    }
    namespace Event {
        interface Tag {
            name: string;
            score: number;
        }
    }
}
export interface HijackEventsParams {
    /**
     * 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';
    /**
     * The potential hijacker AS of a BGP hijack event
     */
    hijackerAsn?: number;
    /**
     * The potential hijacker or victim AS of a BGP hijack event
     */
    involvedAsn?: number;
    /**
     * The country code of the potential hijacker or victim AS of a BGP hijack event
     */
    involvedCountry?: string;
    /**
     * The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
     */
    maxConfidence?: number;
    /**
     * The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
     */
    minConfidence?: number;
    /**
     * Current page number, starting from 1
     */
    page?: number;
    /**
     * Number of entries per page
     */
    per_page?: number;
    /**
     * The prefix hijacked during a BGP hijack event
     */
    prefix?: string;
    /**
     * Sort events by field
     */
    sortBy?: 'ID' | 'TIME' | 'CONFIDENCE';
    /**
     * Sort order
     */
    sortOrder?: 'ASC' | 'DESC';
    /**
     * The potential victim AS of a BGP hijack event
     */
    victimAsn?: number;
}
export declare namespace Hijacks {
    export import HijackEventsResponse = HijacksAPI.HijackEventsResponse;
    export import HijackEventsParams = HijacksAPI.HijackEventsParams;
}
//# sourceMappingURL=hijacks.d.ts.map