UNPKG

cloudflare

Version:

The official TypeScript library for the Cloudflare API

661 lines 25.7 kB
import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as TimeseriesGroupsAPI from 'cloudflare/resources/radar/attacks/layer3/timeseries-groups'; export declare class TimeseriesGroups extends APIResource { /** * Percentage distribution of attacks by bitrate over time. */ bitrate(query?: TimeseriesGroupBitrateParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBitrateResponse>; bitrate(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupBitrateResponse>; /** * Percentage distribution of attacks by duration over time. */ duration(query?: TimeseriesGroupDurationParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupDurationResponse>; duration(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupDurationResponse>; /** * Get a timeseries of the percentage distribution of network protocols in Layer * 3/4 attacks. */ get(query?: TimeseriesGroupGetParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupGetResponse>; get(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupGetResponse>; /** * Percentage distribution of attacks by industry used over time. */ industry(query?: TimeseriesGroupIndustryParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIndustryResponse>; industry(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIndustryResponse>; /** * Percentage distribution of attacks by ip version used over time. */ ipVersion(query?: TimeseriesGroupIPVersionParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIPVersionResponse>; ipVersion(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupIPVersionResponse>; /** * Percentage distribution of attacks by protocol used over time. */ protocol(query?: TimeseriesGroupProtocolParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupProtocolResponse>; protocol(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupProtocolResponse>; /** * Percentage distribution of attacks by vector used over time. */ vector(query?: TimeseriesGroupVectorParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVectorResponse>; vector(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVectorResponse>; /** * Percentage distribution of attacks by vertical used over time. */ vertical(query?: TimeseriesGroupVerticalParams, options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVerticalResponse>; vertical(options?: Core.RequestOptions): Core.APIPromise<TimeseriesGroupVerticalResponse>; } export interface TimeseriesGroupBitrateResponse { meta: unknown; serie_0: TimeseriesGroupBitrateResponse.Serie0; } export declare namespace TimeseriesGroupBitrateResponse { interface Serie0 { _1_GBPS_TO_10_GBPS: Array<string>; _10_GBPS_TO_100_GBPS: Array<string>; _500_MBPS_TO_1_GBPS: Array<string>; OVER_100_GBPS: Array<string>; timestamps: Array<string>; UNDER_500_MBPS: Array<string>; } } export interface TimeseriesGroupDurationResponse { meta: unknown; serie_0: TimeseriesGroupDurationResponse.Serie0; } export declare namespace TimeseriesGroupDurationResponse { interface Serie0 { _1_HOUR_TO_3_HOURS: Array<string>; _10_MINS_TO_20_MINS: Array<string>; _20_MINS_TO_40_MINS: Array<string>; _40_MINS_TO_1_HOUR: Array<string>; OVER_3_HOURS: Array<string>; timestamps: Array<string>; UNDER_10_MINS: Array<string>; } } export interface TimeseriesGroupGetResponse { meta: TimeseriesGroupGetResponse.Meta; serie_0: TimeseriesGroupGetResponse.Serie0; } export declare namespace TimeseriesGroupGetResponse { interface Meta { aggInterval: string; dateRange: Array<Meta.DateRange>; lastUpdated: 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 Serie0 { gre: Array<string>; icmp: Array<string>; tcp: Array<string>; timestamps: Array<string>; udp: Array<string>; } } export interface TimeseriesGroupIndustryResponse { meta: unknown; serie_0: TimeseriesGroupIndustryResponse.Serie0; } export declare namespace TimeseriesGroupIndustryResponse { interface Serie0 { timestamps: Array<string>; [k: string]: Array<string>; } } export interface TimeseriesGroupIPVersionResponse { meta: unknown; serie_0: TimeseriesGroupIPVersionResponse.Serie0; } export declare namespace TimeseriesGroupIPVersionResponse { interface Serie0 { IPv4: Array<string>; IPv6: Array<string>; timestamps: Array<string>; } } export interface TimeseriesGroupProtocolResponse { meta: unknown; serie_0: TimeseriesGroupProtocolResponse.Serie0; } export declare namespace TimeseriesGroupProtocolResponse { interface Serie0 { GRE: Array<string>; ICMP: Array<string>; TCP: Array<string>; timestamps: Array<string>; UDP: Array<string>; } } export interface TimeseriesGroupVectorResponse { meta: unknown; serie_0: TimeseriesGroupVectorResponse.Serie0; } export declare namespace TimeseriesGroupVectorResponse { interface Serie0 { timestamps: Array<string>; [k: string]: Array<string>; } } export interface TimeseriesGroupVerticalResponse { meta: unknown; serie_0: TimeseriesGroupVerticalResponse.Serie0; } export declare namespace TimeseriesGroupVerticalResponse { interface Serie0 { timestamps: Array<string>; [k: string]: Array<string>; } } export interface TimeseriesGroupBitrateParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; /** * Array of L3/4 attack types. */ protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>; } export interface TimeseriesGroupDurationParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; /** * Array of L3/4 attack types. */ protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>; } export interface TimeseriesGroupGetParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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 TimeseriesGroupIndustryParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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'>; /** * Limit the number of objects (eg browsers, verticals, etc) to the top items over * the time range. */ limitPerGroup?: number; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; } export interface TimeseriesGroupIPVersionParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; /** * Array of L3/4 attack types. */ protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>; } export interface TimeseriesGroupProtocolParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; } export interface TimeseriesGroupVectorParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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'>; /** * Limit the number of objects (eg browsers, verticals, etc) to the top items over * the time range. */ limitPerGroup?: number; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; /** * Array of L3/4 attack types. */ protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>; } export interface TimeseriesGroupVerticalParams { /** * Aggregation interval results should be returned in (for example, in 15 minutes * or 1 hour intervals). Refer to * [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). */ aggInterval?: '15m' | '1h' | '1d' | '1w'; /** * 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'>; /** * Limit the number of objects (eg browsers, verticals, etc) to the top items over * the time range. */ limitPerGroup?: number; /** * 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>; /** * Normalization method applied. Refer to * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). */ normalization?: 'PERCENTAGE' | 'MIN0_MAX'; } export declare namespace TimeseriesGroups { export import TimeseriesGroupBitrateResponse = TimeseriesGroupsAPI.TimeseriesGroupBitrateResponse; export import TimeseriesGroupDurationResponse = TimeseriesGroupsAPI.TimeseriesGroupDurationResponse; export import TimeseriesGroupGetResponse = TimeseriesGroupsAPI.TimeseriesGroupGetResponse; export import TimeseriesGroupIndustryResponse = TimeseriesGroupsAPI.TimeseriesGroupIndustryResponse; export import TimeseriesGroupIPVersionResponse = TimeseriesGroupsAPI.TimeseriesGroupIPVersionResponse; export import TimeseriesGroupProtocolResponse = TimeseriesGroupsAPI.TimeseriesGroupProtocolResponse; export import TimeseriesGroupVectorResponse = TimeseriesGroupsAPI.TimeseriesGroupVectorResponse; export import TimeseriesGroupVerticalResponse = TimeseriesGroupsAPI.TimeseriesGroupVerticalResponse; export import TimeseriesGroupBitrateParams = TimeseriesGroupsAPI.TimeseriesGroupBitrateParams; export import TimeseriesGroupDurationParams = TimeseriesGroupsAPI.TimeseriesGroupDurationParams; export import TimeseriesGroupGetParams = TimeseriesGroupsAPI.TimeseriesGroupGetParams; export import TimeseriesGroupIndustryParams = TimeseriesGroupsAPI.TimeseriesGroupIndustryParams; export import TimeseriesGroupIPVersionParams = TimeseriesGroupsAPI.TimeseriesGroupIPVersionParams; export import TimeseriesGroupProtocolParams = TimeseriesGroupsAPI.TimeseriesGroupProtocolParams; export import TimeseriesGroupVectorParams = TimeseriesGroupsAPI.TimeseriesGroupVectorParams; export import TimeseriesGroupVerticalParams = TimeseriesGroupsAPI.TimeseriesGroupVerticalParams; } //# sourceMappingURL=timeseries-groups.d.ts.map