cloudflare
Version:
The official TypeScript library for the Cloudflare API
127 lines • 4.32 kB
TypeScript
import { APIResource } from "../../../../core/resource.js";
import { PagePromise, V4PagePagination, type V4PagePaginationParams } from "../../../../core/pagination.js";
import { RequestOptions } from "../../../../internal/request-options.js";
export declare class BaseEvents extends APIResource {
static readonly _key: readonly ['radar', 'bgp', 'hijacks', 'events'];
/**
* Retrieves the BGP hijack events.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const eventListResponse of client.radar.bgp.hijacks.events.list()) {
* // ...
* }
* ```
*/
list(query?: EventListParams | null | undefined, options?: RequestOptions): PagePromise<EventListResponsesV4PagePagination, EventListResponse>;
}
export declare class Events extends BaseEvents {
}
export type EventListResponsesV4PagePagination = V4PagePagination<EventListResponse>;
export interface EventListResponse {
asn_info: Array<EventListResponse.ASNInfo>;
events: Array<EventListResponse.Event>;
total_monitors: number;
}
export declare namespace EventListResponse {
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 EventListParams extends V4PagePaginationParams {
/**
* End of the date range (inclusive). Alternative to `dateRange`; provide together
* with `dateStart`.
*/
dateEnd?: string;
/**
* Filters results by a relative date range ending at the current time. Use `<n>d`
* for days (up to `364d`) or `<n>w` for weeks (up to `52w`), e.g. `7d`. Append
* `control` to request the equivalent previous period for comparison: the
* comparison window is shifted back by the current window's length rounded up to a
* whole number of weeks, so it keeps the same weekday alignment and does not
* overlap the current window (e.g. `3dcontrol` covers days -10 to -7, `7dcontrol`
* covers days -14 to -7, `28dcontrol` covers days -56 to -28, and `10dcontrol`
* covers days -24 to -14). Mutually exclusive with `dateStart`/`dateEnd`.
*/
dateRange?: string;
/**
* Start of the date range (inclusive). Alternative to `dateRange`; provide
* together with `dateEnd`.
*/
dateStart?: string;
/**
* The unique identifier of a event.
*/
eventId?: number;
/**
* Format in which results will be returned.
*/
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;
/**
* Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).
*/
maxConfidence?: number;
/**
* Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high).
*/
minConfidence?: number;
prefix?: string;
/**
* Sorts results by the specified field.
*/
sortBy?: 'ID' | 'TIME' | 'CONFIDENCE';
/**
* Sort order.
*/
sortOrder?: 'ASC' | 'DESC';
/**
* The potential victim AS of a BGP hijack event.
*/
victimAsn?: number;
}
export declare namespace Events {
export { type EventListResponse as EventListResponse, type EventListResponsesV4PagePagination as EventListResponsesV4PagePagination, type EventListParams as EventListParams, };
}
//# sourceMappingURL=events.d.ts.map