cloudflare
Version:
The official TypeScript library for the Cloudflare API
594 lines (515 loc) • 18.3 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../core/resource';
import * as SummaryAPI from './summary';
import {
BaseSummary,
Summary,
SummaryBotClassParams,
SummaryBotClassResponse,
SummaryCompromisedParams,
SummaryCompromisedResponse,
} from './summary';
import * as TimeseriesGroupsAPI from './timeseries-groups';
import {
BaseTimeseriesGroups,
TimeseriesGroupBotClassParams,
TimeseriesGroupBotClassResponse,
TimeseriesGroupCompromisedParams,
TimeseriesGroupCompromisedResponse,
TimeseriesGroups,
} from './timeseries-groups';
import { APIPromise } from '../../../core/api-promise';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';
export class BaseLeakedCredentials extends APIResource {
static override readonly _key: readonly ['radar', 'leakedCredentials'] = Object.freeze([
'radar',
'leakedCredentials',
] as const);
/**
* Retrieves an aggregated summary of HTTP authentication requests grouped by the
* specified dimension.
*
* @example
* ```ts
* const response =
* await client.radar.leakedCredentials.summaryV2(
* 'COMPROMISED',
* );
* ```
*/
summaryV2(
dimension: 'COMPROMISED' | 'BOT_CLASS',
query: LeakedCredentialSummaryV2Params | null | undefined = {},
options?: RequestOptions,
): APIPromise<LeakedCredentialSummaryV2Response> {
return (
this._client.get(path`/radar/leaked_credential_checks/summary/${dimension}`, {
query,
...options,
}) as APIPromise<{ result: LeakedCredentialSummaryV2Response }>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the distribution of HTTP authentication requests, grouped by the
* specified dimension over time.
*
* @example
* ```ts
* const response =
* await client.radar.leakedCredentials.timeseriesGroupsV2(
* 'COMPROMISED',
* );
* ```
*/
timeseriesGroupsV2(
dimension: 'COMPROMISED' | 'BOT_CLASS',
query: LeakedCredentialTimeseriesGroupsV2Params | null | undefined = {},
options?: RequestOptions,
): APIPromise<LeakedCredentialTimeseriesGroupsV2Response> {
return (
this._client.get(path`/radar/leaked_credential_checks/timeseries_groups/${dimension}`, {
query,
...options,
}) as APIPromise<{ result: LeakedCredentialTimeseriesGroupsV2Response }>
)._thenUnwrap((obj) => obj.result);
}
}
export class LeakedCredentials extends BaseLeakedCredentials {
summary: SummaryAPI.Summary = new SummaryAPI.Summary(this._client);
timeseriesGroups: TimeseriesGroupsAPI.TimeseriesGroups = new TimeseriesGroupsAPI.TimeseriesGroups(
this._client,
);
}
export interface LeakedCredentialSummaryV2Response {
/**
* Metadata for the results.
*/
meta: LeakedCredentialSummaryV2Response.Meta;
summary_0: { [key: string]: string };
}
export namespace LeakedCredentialSummaryV2Response {
/**
* Metadata for the results.
*/
export interface Meta {
confidenceInfo: Meta.ConfidenceInfo;
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 LeakedCredentialTimeseriesGroupsV2Response {
/**
* Metadata for the results.
*/
meta: LeakedCredentialTimeseriesGroupsV2Response.Meta;
serie_0: LeakedCredentialTimeseriesGroupsV2Response.Serie0;
}
export namespace LeakedCredentialTimeseriesGroupsV2Response {
/**
* Metadata for the results.
*/
export interface Meta {
/**
* Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
* Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
*/
aggInterval: 'FIFTEEN_MINUTES' | 'ONE_HOUR' | 'ONE_DAY' | 'ONE_WEEK' | 'ONE_MONTH';
confidenceInfo: Meta.ConfidenceInfo;
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 Serie0 {
timestamps: Array<string>;
[]: Array<string> | Array<string> | undefined;
}
}
export interface LeakedCredentialSummaryV2Params {
/**
* 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 by bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Filters results by compromised credential status (clean vs. compromised).
*/
compromised?: Array<'CLEAN' | 'COMPROMISED'>;
/**
* 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';
/**
* Limits the number of objects per group to the top items within the specified
* time range. When item count exceeds the limit, extra items appear grouped under
* an "other" category. Only supported on high-cardinality dimensions; otherwise
* the request is rejected. Minimum value is 2.
*/
limitPerGroup?: 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>;
}
export interface LeakedCredentialTimeseriesGroupsV2Params {
/**
* Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
* Refer to
* [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
* When omitted, the interval is auto-selected from the requested date range; finer
* intervals are only available for shorter ranges. If the requested interval is
* too granular for the date range, the request is rejected.
*/
aggInterval?: '15m' | '1h' | '1d' | '1w';
/**
* 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 by bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Filters results by leaked credential check result.
*/
checkResult?: Array<
| 'CLEAN'
| 'USERNAME_LEAKED'
| 'USERNAME_PASSWORD_SIMILAR'
| 'USERNAME_AND_PASSWORD_LEAKED'
| 'PASSWORD_LEAKED'
>;
/**
* Filters results by compromised credential status (clean vs. compromised).
*/
compromised?: Array<'CLEAN' | 'COMPROMISED'>;
/**
* 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';
/**
* Limits the number of objects per group to the top items within the specified
* time range. When item count exceeds the limit, extra items appear grouped under
* an "other" category. Only supported on high-cardinality dimensions; otherwise
* the request is rejected. Minimum value is 2.
*/
limitPerGroup?: 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>;
/**
* Normalization method applied to the results. Refer to
* [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
* `PERCENTAGE_CHANGE` requires exactly one comparison series (e.g. a `control`
* date range).
*/
normalization?: 'PERCENTAGE_CHANGE' | 'MIN0_MAX';
}
LeakedCredentials.Summary = Summary;
LeakedCredentials.BaseSummary = BaseSummary;
LeakedCredentials.TimeseriesGroups = TimeseriesGroups;
LeakedCredentials.BaseTimeseriesGroups = BaseTimeseriesGroups;
export declare namespace LeakedCredentials {
export {
type LeakedCredentialSummaryV2Response as LeakedCredentialSummaryV2Response,
type LeakedCredentialTimeseriesGroupsV2Response as LeakedCredentialTimeseriesGroupsV2Response,
type LeakedCredentialSummaryV2Params as LeakedCredentialSummaryV2Params,
type LeakedCredentialTimeseriesGroupsV2Params as LeakedCredentialTimeseriesGroupsV2Params,
};
export {
Summary as Summary,
BaseSummary as BaseSummary,
type SummaryBotClassResponse as SummaryBotClassResponse,
type SummaryCompromisedResponse as SummaryCompromisedResponse,
type SummaryBotClassParams as SummaryBotClassParams,
type SummaryCompromisedParams as SummaryCompromisedParams,
};
export {
TimeseriesGroups as TimeseriesGroups,
BaseTimeseriesGroups as BaseTimeseriesGroups,
type TimeseriesGroupBotClassResponse as TimeseriesGroupBotClassResponse,
type TimeseriesGroupCompromisedResponse as TimeseriesGroupCompromisedResponse,
type TimeseriesGroupBotClassParams as TimeseriesGroupBotClassParams,
type TimeseriesGroupCompromisedParams as TimeseriesGroupCompromisedParams,
};
}