cloudflare
Version:
The official TypeScript library for the Cloudflare API
593 lines • 20.3 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as SummaryAPI from 'cloudflare/resources/radar/attacks/layer3/summary';
export declare class Summary extends APIResource {
/**
* Percentage distribution of attacks by bitrate.
*/
bitrate(query?: SummaryBitrateParams, options?: Core.RequestOptions): Core.APIPromise<SummaryBitrateResponse>;
bitrate(options?: Core.RequestOptions): Core.APIPromise<SummaryBitrateResponse>;
/**
* Percentage distribution of attacks by duration.
*/
duration(query?: SummaryDurationParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDurationResponse>;
duration(options?: Core.RequestOptions): Core.APIPromise<SummaryDurationResponse>;
/**
* Percentage distribution of network protocols in layer 3/4 attacks over a given
* time period.
*/
get(query?: SummaryGetParams, options?: Core.RequestOptions): Core.APIPromise<SummaryGetResponse>;
get(options?: Core.RequestOptions): Core.APIPromise<SummaryGetResponse>;
/**
* Percentage distribution of attacks by ip version used.
*/
ipVersion(query?: SummaryIPVersionParams, options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>;
ipVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>;
/**
* Percentage distribution of attacks by protocol used.
*/
protocol(query?: SummaryProtocolParams, options?: Core.RequestOptions): Core.APIPromise<SummaryProtocolResponse>;
protocol(options?: Core.RequestOptions): Core.APIPromise<SummaryProtocolResponse>;
/**
* Percentage distribution of attacks by vector.
*/
vector(query?: SummaryVectorParams, options?: Core.RequestOptions): Core.APIPromise<SummaryVectorResponse>;
vector(options?: Core.RequestOptions): Core.APIPromise<SummaryVectorResponse>;
}
export interface SummaryBitrateResponse {
meta: SummaryBitrateResponse.Meta;
summary_0: SummaryBitrateResponse.Summary0;
}
export declare namespace SummaryBitrateResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
_1_GBPS_TO_10_GBPS: string;
_10_GBPS_TO_100_GBPS: string;
_500_MBPS_TO_1_GBPS: string;
OVER_100_GBPS: string;
UNDER_500_MBPS: string;
}
}
export interface SummaryDurationResponse {
meta: SummaryDurationResponse.Meta;
summary_0: SummaryDurationResponse.Summary0;
}
export declare namespace SummaryDurationResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
_1_HOUR_TO_3_HOURS: string;
_10_MINS_TO_20_MINS: string;
_20_MINS_TO_40_MINS: string;
_40_MINS_TO_1_HOUR: string;
OVER_3_HOURS: string;
UNDER_10_MINS: string;
}
}
export interface SummaryGetResponse {
meta: SummaryGetResponse.Meta;
summary_0: SummaryGetResponse.Summary0;
}
export declare namespace SummaryGetResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
gre: string;
icmp: string;
tcp: string;
udp: string;
}
}
export interface SummaryIPVersionResponse {
meta: SummaryIPVersionResponse.Meta;
summary_0: SummaryIPVersionResponse.Summary0;
}
export declare namespace SummaryIPVersionResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
IPv4: string;
IPv6: string;
}
}
export interface SummaryProtocolResponse {
meta: SummaryProtocolResponse.Meta;
summary_0: SummaryProtocolResponse.Summary0;
}
export declare namespace SummaryProtocolResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
GRE: string;
ICMP: string;
TCP: string;
UDP: string;
}
}
export interface SummaryVectorResponse {
meta: SummaryVectorResponse.Meta;
summary_0: Record<string, Array<string>>;
}
export declare namespace SummaryVectorResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface SummaryBitrateParams {
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface SummaryDurationParams {
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface SummaryGetParams {
/**
* Array of comma separated list of ASNs, start with `-` to exclude from results.
* For example, `-174, 3356` excludes results from AS174, but includes results from
* AS3356.
*/
asn?: Array<string>;
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
}
export interface SummaryIPVersionParams {
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface SummaryProtocolParams {
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
}
export interface SummaryVectorParams {
/**
* Array of comma separated list of continents (alpha-2 continent codes). Start
* with `-` to exclude from results. For example, `-EU,NA` excludes results from
* Europe, but includes results from North America.
*/
continent?: Array<string>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Together with the `location` parameter, will apply the filter to origin or
* target location.
*/
direction?: 'ORIGIN' | 'TARGET';
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of comma separated list of locations (alpha-2 country codes). Start with
* `-` to exclude from results. For example, `-US,PT` excludes results from the US,
* but includes results from PT.
*/
location?: Array<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Array of L3/4 attack types.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export declare namespace Summary {
export import SummaryBitrateResponse = SummaryAPI.SummaryBitrateResponse;
export import SummaryDurationResponse = SummaryAPI.SummaryDurationResponse;
export import SummaryGetResponse = SummaryAPI.SummaryGetResponse;
export import SummaryIPVersionResponse = SummaryAPI.SummaryIPVersionResponse;
export import SummaryProtocolResponse = SummaryAPI.SummaryProtocolResponse;
export import SummaryVectorResponse = SummaryAPI.SummaryVectorResponse;
export import SummaryBitrateParams = SummaryAPI.SummaryBitrateParams;
export import SummaryDurationParams = SummaryAPI.SummaryDurationParams;
export import SummaryGetParams = SummaryAPI.SummaryGetParams;
export import SummaryIPVersionParams = SummaryAPI.SummaryIPVersionParams;
export import SummaryProtocolParams = SummaryAPI.SummaryProtocolParams;
export import SummaryVectorParams = SummaryAPI.SummaryVectorParams;
}
//# sourceMappingURL=summary.d.ts.map