cloudflare
Version:
The official TypeScript library for the Cloudflare API
130 lines • 4.55 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
export declare class Top extends APIResource {
/**
* Retrieves the top autonomous systems by network traffic (NetFlows).
*/
ases(query?: TopAsesParams, options?: Core.RequestOptions): Core.APIPromise<TopAsesResponse>;
ases(options?: Core.RequestOptions): Core.APIPromise<TopAsesResponse>;
/**
* Retrieves the top locations by network traffic (NetFlows).
*/
locations(query?: TopLocationsParams, options?: Core.RequestOptions): Core.APIPromise<TopLocationsResponse>;
locations(options?: Core.RequestOptions): Core.APIPromise<TopLocationsResponse>;
}
export interface TopAsesResponse {
top_0: Array<TopAsesResponse.Top0>;
}
export declare namespace TopAsesResponse {
interface Top0 {
clientASN: number;
clientASName: string;
value: string;
}
}
export interface TopLocationsResponse {
top_0: Array<TopLocationsResponse.Top0>;
}
export declare namespace TopLocationsResponse {
interface Top0 {
clientCountryAlpha2: string;
clientCountryName: string;
value: string;
}
}
export interface TopAsesParams {
/**
* Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to
* exclude ASNs from results. For example, `-174, 3356` excludes results from
* AS174, but includes results from AS3356.
*/
asn?: Array<string>;
/**
* Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to
* exclude continents from results. For example, `-EU,NA` excludes results from EU,
* but includes results from NA.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude
* locations from results. For example, `-US,PT` excludes results from the US, but
* includes results from PT.
*/
location?: Array<string>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export interface TopLocationsParams {
/**
* Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to
* exclude ASNs from results. For example, `-174, 3356` excludes results from
* AS174, but includes results from AS3356.
*/
asn?: Array<string>;
/**
* Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to
* exclude continents from results. For example, `-EU,NA` excludes results from EU,
* but includes results from NA.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude
* locations from results. For example, `-US,PT` excludes results from the US, but
* includes results from PT.
*/
location?: Array<string>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
}
export declare namespace Top {
export { type TopAsesResponse as TopAsesResponse, type TopLocationsResponse as TopLocationsResponse, type TopAsesParams as TopAsesParams, type TopLocationsParams as TopLocationsParams, };
}
//# sourceMappingURL=top.d.ts.map