cloudflare
Version:
The official TypeScript library for the Cloudflare API
842 lines (745 loc) • 19.7 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../core/resource';
import { APIPromise } from '../../../core/api-promise';
import { RequestOptions } from '../../../internal/request-options';
export class BaseTop extends APIResource {
static override readonly _key: readonly ['radar', 'dns', 'top'] = Object.freeze([
'radar',
'dns',
'top',
] as const);
/**
* Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS
* resolver.
*
* @example
* ```ts
* const response = await client.radar.dns.top.ases();
* ```
*/
ases(query: TopAsesParams | null | undefined = {}, options?: RequestOptions): APIPromise<TopAsesResponse> {
return (
this._client.get('/radar/dns/top/ases', { query, ...options }) as APIPromise<{
result: TopAsesResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver.
*
* @example
* ```ts
* const response = await client.radar.dns.top.locations();
* ```
*/
locations(
query: TopLocationsParams | null | undefined = {},
options?: RequestOptions,
): APIPromise<TopLocationsResponse> {
return (
this._client.get('/radar/dns/top/locations', { query, ...options }) as APIPromise<{
result: TopLocationsResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export class Top extends BaseTop {}
export interface TopAsesResponse {
/**
* Metadata for the results.
*/
meta: TopAsesResponse.Meta;
top_0: Array<TopAsesResponse.Top0>;
}
export namespace TopAsesResponse {
/**
* 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 {
clientASN: number;
clientASName: string;
/**
* A numeric string.
*/
value: string;
}
}
export interface TopLocationsResponse {
/**
* Metadata for the results.
*/
meta: TopLocationsResponse.Meta;
top_0: Array<TopLocationsResponse.Top0>;
}
export namespace TopLocationsResponse {
/**
* 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 {
clientCountryAlpha2: string;
clientCountryName: string;
/**
* A numeric string.
*/
value: string;
}
}
export interface TopAsesParams {
/**
* Filters results by Autonomous System. Specify one or more Autonomous System
* Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
* results. For example, `-174, 3356` excludes results from AS174, but includes
* results from AS3356.
*/
asn?: Array<string>;
/**
* Filters results based on cache status.
*/
cacheHit?: Array<boolean>;
/**
* 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>;
/**
* Filters results based on DNSSEC (DNS Security Extensions) support.
*/
dnssec?: Array<'INVALID' | 'INSECURE' | 'SECURE' | 'OTHER'>;
/**
* Filters results based on DNSSEC (DNS Security Extensions) client awareness.
*/
dnssecAware?: Array<'SUPPORTED' | 'NOT_SUPPORTED'>;
/**
* Filters results based on DNSSEC-validated answers by end-to-end security status.
*/
dnssecE2e?: Array<boolean>;
/**
* Filters results by domain name. When set, no other DNS filter may be used — only
* date filtering (`dateRange`, or `dateStart`/`dateEnd`) is allowed — and the date
* range cannot exceed 31 days.
*/
domain?: 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>;
/**
* Filters results based on whether the queries have a matching answer.
*/
matchingAnswer?: Array<boolean>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: Array<boolean>;
/**
* Filters results by DNS transport protocol.
*/
protocol?: Array<'UDP' | 'TCP' | 'HTTPS' | 'TLS'>;
/**
* Filters results by DNS query type.
*/
queryType?: Array<
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null
>;
/**
* Filters results by DNS response code.
*/
responseCode?: Array<
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE'
>;
/**
* Filters results by DNS response TTL.
*/
responseTtl?: Array<
'LTE_1M' | 'GT_1M_LTE_5M' | 'GT_5M_LTE_15M' | 'GT_15M_LTE_1H' | 'GT_1H_LTE_1D' | 'GT_1D_LTE_1W' | 'GT_1W'
>;
}
export interface TopLocationsParams {
/**
* Filters results by Autonomous System. Specify one or more Autonomous System
* Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
* results. For example, `-174, 3356` excludes results from AS174, but includes
* results from AS3356.
*/
asn?: Array<string>;
/**
* Filters results based on cache status.
*/
cacheHit?: Array<boolean>;
/**
* 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>;
/**
* Filters results based on DNSSEC (DNS Security Extensions) support.
*/
dnssec?: Array<'INVALID' | 'INSECURE' | 'SECURE' | 'OTHER'>;
/**
* Filters results based on DNSSEC (DNS Security Extensions) client awareness.
*/
dnssecAware?: Array<'SUPPORTED' | 'NOT_SUPPORTED'>;
/**
* Filters results based on DNSSEC-validated answers by end-to-end security status.
*/
dnssecE2e?: Array<boolean>;
/**
* Filters results by domain name. When set, no other DNS filter may be used — only
* date filtering (`dateRange`, or `dateStart`/`dateEnd`) is allowed — and the date
* range cannot exceed 31 days.
*/
domain?: 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>;
/**
* Filters results based on whether the queries have a matching answer.
*/
matchingAnswer?: Array<boolean>;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* Specifies whether the response includes empty DNS responses (NODATA).
*/
nodata?: Array<boolean>;
/**
* Filters results by DNS transport protocol.
*/
protocol?: Array<'UDP' | 'TCP' | 'HTTPS' | 'TLS'>;
/**
* Filters results by DNS query type.
*/
queryType?: Array<
| 'A'
| 'AAAA'
| 'A6'
| 'AFSDB'
| 'ANY'
| 'APL'
| 'ATMA'
| 'AXFR'
| 'CAA'
| 'CDNSKEY'
| 'CDS'
| 'CERT'
| 'CNAME'
| 'CSYNC'
| 'DHCID'
| 'DLV'
| 'DNAME'
| 'DNSKEY'
| 'DOA'
| 'DS'
| 'EID'
| 'EUI48'
| 'EUI64'
| 'GPOS'
| 'GID'
| 'HINFO'
| 'HIP'
| 'HTTPS'
| 'IPSECKEY'
| 'ISDN'
| 'IXFR'
| 'KEY'
| 'KX'
| 'L32'
| 'L64'
| 'LOC'
| 'LP'
| 'MAILA'
| 'MAILB'
| 'MB'
| 'MD'
| 'MF'
| 'MG'
| 'MINFO'
| 'MR'
| 'MX'
| 'NAPTR'
| 'NB'
| 'NBSTAT'
| 'NID'
| 'NIMLOC'
| 'NINFO'
| 'NS'
| 'NSAP'
| 'NSEC'
| 'NSEC3'
| 'NSEC3PARAM'
| 'NULL'
| 'NXT'
| 'OPENPGPKEY'
| 'OPT'
| 'PTR'
| 'PX'
| 'RKEY'
| 'RP'
| 'RRSIG'
| 'RT'
| 'SIG'
| 'SINK'
| 'SMIMEA'
| 'SOA'
| 'SPF'
| 'SRV'
| 'SSHFP'
| 'SVCB'
| 'TA'
| 'TALINK'
| 'TKEY'
| 'TLSA'
| 'TSIG'
| 'TXT'
| 'UINFO'
| 'UID'
| 'UNSPEC'
| 'URI'
| 'WKS'
| 'X25'
| 'ZONEMD'
| null
>;
/**
* Filters results by DNS response code.
*/
responseCode?: Array<
| 'NOERROR'
| 'FORMERR'
| 'SERVFAIL'
| 'NXDOMAIN'
| 'NOTIMP'
| 'REFUSED'
| 'YXDOMAIN'
| 'YXRRSET'
| 'NXRRSET'
| 'NOTAUTH'
| 'NOTZONE'
| 'BADSIG'
| 'BADKEY'
| 'BADTIME'
| 'BADMODE'
| 'BADNAME'
| 'BADALG'
| 'BADTRUNC'
| 'BADCOOKIE'
>;
/**
* Filters results by DNS response TTL.
*/
responseTtl?: Array<
'LTE_1M' | 'GT_1M_LTE_5M' | 'GT_5M_LTE_15M' | 'GT_15M_LTE_1H' | 'GT_1H_LTE_1D' | 'GT_1D_LTE_1W' | 'GT_1W'
>;
/**
* Filters results by top-level domain. Incompatible with the `ipVersion`,
* `protocol`, `dnssecE2e`, `dnssecAware`, `responseTtl`, and `cacheHit`
* filters/dimensions; this restriction does not apply to country-code TLDs
* (2-letter, e.g. `uk`).
*/
tld?: Array<string>;
}
export declare namespace Top {
export {
type TopAsesResponse as TopAsesResponse,
type TopLocationsResponse as TopLocationsResponse,
type TopAsesParams as TopAsesParams,
type TopLocationsParams as TopLocationsParams,
};
}