cloudflare
Version:
The official TypeScript library for the Cloudflare API
763 lines (650 loc) • 21.3 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../../../core/resource';
import * as LocationsAPI from './locations';
import {
BaseLocations,
LocationOriginParams,
LocationOriginResponse,
LocationTargetParams,
LocationTargetResponse,
Locations,
} from './locations';
import { APIPromise } from '../../../../../core/api-promise';
import { RequestOptions } from '../../../../../internal/request-options';
export class BaseTop extends APIResource {
static override readonly _key: readonly ['radar', 'attacks', 'layer3', 'top'] = Object.freeze([
'radar',
'attacks',
'layer3',
'top',
] as const);
/**
* Retrieves the top layer 3 attacks from origin to target location. Values are a
* percentage out of the total layer 3 attacks (with billing country). You can
* optionally limit the number of attacks by origin/target location (useful if all
* the top attacks are from or to the same location).
*
* @example
* ```ts
* const response =
* await client.radar.attacks.layer3.top.attacks();
* ```
*/
attacks(
query: TopAttacksParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<TopAttacksResponse> {
return (
this._client.get('/radar/attacks/layer3/top/attacks', { query, ...options }) as APIPromise<{
result: TopAttacksResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* This endpoint is deprecated. To continue getting this data, switch to the
* summary by industry endpoint.
*
* @deprecated Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead.
*/
industry(
query: TopIndustryParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<TopIndustryResponse> {
return (
this._client.get('/radar/attacks/layer3/top/industry', { query, ...options }) as APIPromise<{
result: TopIndustryResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* This endpoint is deprecated. To continue getting this data, switch to the
* summary by vertical endpoint.
*
* @deprecated Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead.
*/
vertical(
query: TopVerticalParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<TopVerticalResponse> {
return (
this._client.get('/radar/attacks/layer3/top/vertical', { query, ...options }) as APIPromise<{
result: TopVerticalResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export class Top extends BaseTop {
locations: LocationsAPI.Locations = new LocationsAPI.Locations(this._client);
}
export interface TopAttacksResponse {
/**
* Metadata for the results.
*/
meta: TopAttacksResponse.Meta;
top_0: Array<TopAttacksResponse.Top0>;
}
export namespace TopAttacksResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo | null;
dateRange: Array<Meta.DateRange>;
/**
* Timestamp of the last dataset update.
*/
lastUpdated: string;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization:
| 'PERCENTAGE'
| 'MIN0_MAX'
| 'MIN_MAX'
| 'RAW_VALUES'
| 'PERCENTAGE_CHANGE'
| 'ROLLING_AVERAGE'
| 'OVERLAPPED_PERCENTAGE'
| 'RATIO';
/**
* Measurement units for the results.
*/
units: Array<Meta.Unit>;
}
export namespace Meta {
export interface ConfidenceInfo {
annotations: Array<ConfidenceInfo.Annotation>;
/**
* Provides an indication of how much confidence Cloudflare has in the data.
*/
level: number;
}
export namespace ConfidenceInfo {
/**
* Annotation associated with the result (e.g. outage or other type of event).
*/
export interface Annotation {
/**
* Data source for annotations.
*/
dataSource:
| 'ALL'
| 'AI_BOTS'
| 'AI_GATEWAY'
| 'BGP'
| 'BOTS'
| 'CONNECTION_ANOMALY'
| 'CT'
| 'DNS'
| 'DNS_MAGNITUDE'
| 'DNS_AS112'
| 'DOS'
| 'EMAIL_ROUTING'
| 'EMAIL_SECURITY'
| 'FW'
| 'FW_PG'
| 'HTTP'
| 'HTTP_CONTROL'
| 'HTTP_CRAWLER_REFERER'
| 'HTTP_ORIGINS'
| 'IQI'
| 'LEAKED_CREDENTIALS'
| 'NET'
| 'ROBOTS_TXT'
| 'SPEED'
| 'WORKERS_AI';
description: string;
endDate: string;
/**
* Event type for annotations.
*/
eventType: 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
/**
* Whether event is a single point in time or a time range.
*/
isInstantaneous: boolean;
linkedUrl: string;
startDate: string;
tags?: Array<string>;
}
}
export interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
export interface Unit {
name: string;
value: string;
}
}
export interface Top0 {
originCountryAlpha2: string;
originCountryName: string;
value: string;
}
}
export interface TopIndustryResponse {
/**
* Metadata for the results.
*/
meta: TopIndustryResponse.Meta;
top_0: Array<TopIndustryResponse.Top0>;
}
export namespace TopIndustryResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo | null;
dateRange: Array<Meta.DateRange>;
/**
* Timestamp of the last dataset update.
*/
lastUpdated: string;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization:
| 'PERCENTAGE'
| 'MIN0_MAX'
| 'MIN_MAX'
| 'RAW_VALUES'
| 'PERCENTAGE_CHANGE'
| 'ROLLING_AVERAGE'
| 'OVERLAPPED_PERCENTAGE'
| 'RATIO';
/**
* Measurement units for the results.
*/
units: Array<Meta.Unit>;
}
export namespace Meta {
export interface ConfidenceInfo {
annotations: Array<ConfidenceInfo.Annotation>;
/**
* Provides an indication of how much confidence Cloudflare has in the data.
*/
level: number;
}
export namespace ConfidenceInfo {
/**
* Annotation associated with the result (e.g. outage or other type of event).
*/
export interface Annotation {
/**
* Data source for annotations.
*/
dataSource:
| 'ALL'
| 'AI_BOTS'
| 'AI_GATEWAY'
| 'BGP'
| 'BOTS'
| 'CONNECTION_ANOMALY'
| 'CT'
| 'DNS'
| 'DNS_MAGNITUDE'
| 'DNS_AS112'
| 'DOS'
| 'EMAIL_ROUTING'
| 'EMAIL_SECURITY'
| 'FW'
| 'FW_PG'
| 'HTTP'
| 'HTTP_CONTROL'
| 'HTTP_CRAWLER_REFERER'
| 'HTTP_ORIGINS'
| 'IQI'
| 'LEAKED_CREDENTIALS'
| 'NET'
| 'ROBOTS_TXT'
| 'SPEED'
| 'WORKERS_AI';
description: string;
endDate: string;
/**
* Event type for annotations.
*/
eventType: 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
/**
* Whether event is a single point in time or a time range.
*/
isInstantaneous: boolean;
linkedUrl: string;
startDate: string;
tags?: Array<string>;
}
}
export interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
export interface Unit {
name: string;
value: string;
}
}
export interface Top0 {
name: string;
value: string;
}
}
export interface TopVerticalResponse {
/**
* Metadata for the results.
*/
meta: TopVerticalResponse.Meta;
top_0: Array<TopVerticalResponse.Top0>;
}
export namespace TopVerticalResponse {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo | null;
dateRange: Array<Meta.DateRange>;
/**
* Timestamp of the last dataset update.
*/
lastUpdated: string;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization:
| 'PERCENTAGE'
| 'MIN0_MAX'
| 'MIN_MAX'
| 'RAW_VALUES'
| 'PERCENTAGE_CHANGE'
| 'ROLLING_AVERAGE'
| 'OVERLAPPED_PERCENTAGE'
| 'RATIO';
/**
* Measurement units for the results.
*/
units: Array<Meta.Unit>;
}
export namespace Meta {
export interface ConfidenceInfo {
annotations: Array<ConfidenceInfo.Annotation>;
/**
* Provides an indication of how much confidence Cloudflare has in the data.
*/
level: number;
}
export namespace ConfidenceInfo {
/**
* Annotation associated with the result (e.g. outage or other type of event).
*/
export interface Annotation {
/**
* Data source for annotations.
*/
dataSource:
| 'ALL'
| 'AI_BOTS'
| 'AI_GATEWAY'
| 'BGP'
| 'BOTS'
| 'CONNECTION_ANOMALY'
| 'CT'
| 'DNS'
| 'DNS_MAGNITUDE'
| 'DNS_AS112'
| 'DOS'
| 'EMAIL_ROUTING'
| 'EMAIL_SECURITY'
| 'FW'
| 'FW_PG'
| 'HTTP'
| 'HTTP_CONTROL'
| 'HTTP_CRAWLER_REFERER'
| 'HTTP_ORIGINS'
| 'IQI'
| 'LEAKED_CREDENTIALS'
| 'NET'
| 'ROBOTS_TXT'
| 'SPEED'
| 'WORKERS_AI';
description: string;
endDate: string;
/**
* Event type for annotations.
*/
eventType: 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
/**
* Whether event is a single point in time or a time range.
*/
isInstantaneous: boolean;
linkedUrl: string;
startDate: string;
tags?: Array<string>;
}
}
export interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
export interface Unit {
name: string;
value: string;
}
}
export interface Top0 {
name: string;
value: string;
}
}
export interface TopAttacksParams {
/**
* Filters results by continent. Specify a comma-separated list of alpha-2 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). Alternative to `dateRange`; provide together
* with `dateStart`. When requesting comparison series, every series must resolve
* to the same duration as the main series. Each `dateStart`/`dateEnd` is floored
* to the nearest 15 minutes before evaluation, so windows whose durations match
* only before alignment may be rejected.
*/
dateEnd?: Array<string>;
/**
* Filters results by relative date range ending at the current time, with each
* value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w`
* for weeks (up to `52w`). 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. `7dcontrol`
* covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass
* `7d` and `7dcontrol` to compare this week with the previous week. All series
* must resolve to the same duration as the main series; relative ranges (including
* `control`) satisfy this automatically. Use this parameter or set specific start
* and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range. Alternative to `dateRange`; provide together with
* `dateEnd`. When requesting comparison series, every series must resolve to the
* same duration as the main series. Each `dateStart`/`dateEnd` is floored to the
* nearest 15 minutes before evaluation, so windows whose durations match only
* before alignment may be rejected.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Specifies whether the `limitPerLocation` applies to the source or target
* location.
*/
limitDirection?: 'ORIGIN' | 'TARGET';
/**
* Limits the number of attacks per origin/target (refer to `limitDirection`
* parameter) location.
*/
limitPerLocation?: number;
/**
* Filters results by location. Specify a comma-separated list of 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>;
/**
* Orders results based on attack magnitude, defined by total mitigated bytes or
* total mitigated attacks.
*/
magnitude?: 'MITIGATED_BYTES' | 'MITIGATED_ATTACKS';
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
*/
normalization?: 'PERCENTAGE' | 'MIN_MAX';
/**
* Filters the results by layer 3/4 protocol.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TopIndustryParams {
/**
* Filters results by continent. Specify a comma-separated list of alpha-2 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). Alternative to `dateRange`; provide together
* with `dateStart`. When requesting comparison series, every series must resolve
* to the same duration as the main series. Each `dateStart`/`dateEnd` is floored
* to the nearest 15 minutes before evaluation, so windows whose durations match
* only before alignment may be rejected.
*/
dateEnd?: Array<string>;
/**
* Filters results by relative date range ending at the current time, with each
* value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w`
* for weeks (up to `52w`). 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. `7dcontrol`
* covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass
* `7d` and `7dcontrol` to compare this week with the previous week. All series
* must resolve to the same duration as the main series; relative ranges (including
* `control`) satisfy this automatically. Use this parameter or set specific start
* and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range. Alternative to `dateRange`; provide together with
* `dateEnd`. When requesting comparison series, every series must resolve to the
* same duration as the main series. Each `dateStart`/`dateEnd` is floored to the
* nearest 15 minutes before evaluation, so windows whose durations match only
* before alignment may be rejected.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Filters results by location. Specify a comma-separated list of 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>;
/**
* Filters the results by layer 3/4 protocol.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
export interface TopVerticalParams {
/**
* Filters results by continent. Specify a comma-separated list of alpha-2 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). Alternative to `dateRange`; provide together
* with `dateStart`. When requesting comparison series, every series must resolve
* to the same duration as the main series. Each `dateStart`/`dateEnd` is floored
* to the nearest 15 minutes before evaluation, so windows whose durations match
* only before alignment may be rejected.
*/
dateEnd?: Array<string>;
/**
* Filters results by relative date range ending at the current time, with each
* value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w`
* for weeks (up to `52w`). 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. `7dcontrol`
* covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass
* `7d` and `7dcontrol` to compare this week with the previous week. All series
* must resolve to the same duration as the main series; relative ranges (including
* `control`) satisfy this automatically. Use this parameter or set specific start
* and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range. Alternative to `dateRange`; provide together with
* `dateEnd`. When requesting comparison series, every series must resolve to the
* same duration as the main series. Each `dateStart`/`dateEnd` is floored to the
* nearest 15 minutes before evaluation, so windows whose durations match only
* before alignment may be rejected.
*/
dateStart?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Filters results by location. Specify a comma-separated list of 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>;
/**
* Filters the results by layer 3/4 protocol.
*/
protocol?: Array<'UDP' | 'TCP' | 'ICMP' | 'GRE'>;
}
Top.Locations = Locations;
Top.BaseLocations = BaseLocations;
export declare namespace Top {
export {
type TopAttacksResponse as TopAttacksResponse,
type TopIndustryResponse as TopIndustryResponse,
type TopVerticalResponse as TopVerticalResponse,
type TopAttacksParams as TopAttacksParams,
type TopIndustryParams as TopIndustryParams,
type TopVerticalParams as TopVerticalParams,
};
export {
Locations as Locations,
BaseLocations as BaseLocations,
type LocationOriginResponse as LocationOriginResponse,
type LocationTargetResponse as LocationTargetResponse,
type LocationOriginParams as LocationOriginParams,
type LocationTargetParams as LocationTargetParams,
};
}