UNPKG

cloudflare

Version:

The official TypeScript library for the Cloudflare API

628 lines 24.1 kB
import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import * as SummaryAPI from 'cloudflare/resources/radar/attacks/layer7/summary'; export declare class Summary extends APIResource { /** * Percentage distribution of mitigation techniques in Layer 7 attacks. */ get(query?: SummaryGetParams, options?: Core.RequestOptions): Core.APIPromise<SummaryGetResponse>; get(options?: Core.RequestOptions): Core.APIPromise<SummaryGetResponse>; /** * Percentage distribution of attacks by http method used. */ httpMethod(query?: SummaryHTTPMethodParams, options?: Core.RequestOptions): Core.APIPromise<SummaryHTTPMethodResponse>; httpMethod(options?: Core.RequestOptions): Core.APIPromise<SummaryHTTPMethodResponse>; /** * Percentage distribution of attacks by http version used. */ httpVersion(query?: SummaryHTTPVersionParams, options?: Core.RequestOptions): Core.APIPromise<SummaryHTTPVersionResponse>; httpVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryHTTPVersionResponse>; /** * 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 managed rules used. */ managedRules(query?: SummaryManagedRulesParams, options?: Core.RequestOptions): Core.APIPromise<SummaryManagedRulesResponse>; managedRules(options?: Core.RequestOptions): Core.APIPromise<SummaryManagedRulesResponse>; /** * Percentage distribution of attacks by mitigation product used. */ mitigationProduct(query?: SummaryMitigationProductParams, options?: Core.RequestOptions): Core.APIPromise<SummaryMitigationProductResponse>; mitigationProduct(options?: Core.RequestOptions): Core.APIPromise<SummaryMitigationProductResponse>; } 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 { ACCESS_RULES: string; API_SHIELD: string; BOT_MANAGEMENT: string; DATA_LOSS_PREVENTION: string; DDOS: string; IP_REPUTATION: string; WAF: string; } } export interface SummaryHTTPMethodResponse { meta: SummaryHTTPMethodResponse.Meta; summary_0: SummaryHTTPMethodResponse.Summary0; } export declare namespace SummaryHTTPMethodResponse { 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 { GET: string; POST: string; } } export interface SummaryHTTPVersionResponse { meta: SummaryHTTPVersionResponse.Meta; summary_0: SummaryHTTPVersionResponse.Summary0; } export declare namespace SummaryHTTPVersionResponse { 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 { 'HTTP/1.x': string; 'HTTP/2': string; 'HTTP/3': 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 SummaryManagedRulesResponse { meta: SummaryManagedRulesResponse.Meta; summary_0: SummaryManagedRulesResponse.Summary0; } export declare namespace SummaryManagedRulesResponse { 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 { Bot: string; 'HTTP Anomaly': string; } } export interface SummaryMitigationProductResponse { meta: SummaryMitigationProductResponse.Meta; summary_0: SummaryMitigationProductResponse.Summary0; } export declare namespace SummaryMitigationProductResponse { 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 { DDOS: string; WAF: string; } } 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 SummaryHTTPMethodParams { /** * 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'; /** * Filter for http version. */ httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>; /** * 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 L7 mitigation products. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names that will be used to name the series in responses. */ name?: Array<string>; } export interface SummaryHTTPVersionParams { /** * 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'; /** * Filter for http method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * 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 L7 mitigation products. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * 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 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'; /** * Filter for http method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * Filter for http version. */ httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>; /** * 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 L7 mitigation products. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names that will be used to name the series in responses. */ name?: Array<string>; } export interface SummaryManagedRulesParams { /** * 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'; /** * Filter for http method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * Filter for http version. */ httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>; /** * 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 L7 mitigation products. */ mitigationProduct?: Array<'DDOS' | 'WAF' | 'BOT_MANAGEMENT' | 'ACCESS_RULES' | 'IP_REPUTATION' | 'API_SHIELD' | 'DATA_LOSS_PREVENTION'>; /** * Array of names that will be used to name the series in responses. */ name?: Array<string>; } export interface SummaryMitigationProductParams { /** * 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'; /** * Filter for http method. */ httpMethod?: Array<'GET' | 'POST' | 'DELETE' | 'PUT' | 'HEAD' | 'PURGE' | 'OPTIONS' | 'PROPFIND' | 'MKCOL' | 'PATCH' | 'ACL' | 'BCOPY' | 'BDELETE' | 'BMOVE' | 'BPROPFIND' | 'BPROPPATCH' | 'CHECKIN' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'LABEL' | 'LOCK' | 'MERGE' | 'MKACTIVITY' | 'MKWORKSPACE' | 'MOVE' | 'NOTIFY' | 'ORDERPATCH' | 'POLL' | 'PROPPATCH' | 'REPORT' | 'SEARCH' | 'SUBSCRIBE' | 'TRACE' | 'UNCHECKOUT' | 'UNLOCK' | 'UNSUBSCRIBE' | 'UPDATE' | 'VERSIONCONTROL' | 'BASELINECONTROL' | 'XMSENUMATTS' | 'RPC_OUT_DATA' | 'RPC_IN_DATA' | 'JSON' | 'COOK' | 'TRACK'>; /** * Filter for http version. */ httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>; /** * 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 declare namespace Summary { export import SummaryGetResponse = SummaryAPI.SummaryGetResponse; export import SummaryHTTPMethodResponse = SummaryAPI.SummaryHTTPMethodResponse; export import SummaryHTTPVersionResponse = SummaryAPI.SummaryHTTPVersionResponse; export import SummaryIPVersionResponse = SummaryAPI.SummaryIPVersionResponse; export import SummaryManagedRulesResponse = SummaryAPI.SummaryManagedRulesResponse; export import SummaryMitigationProductResponse = SummaryAPI.SummaryMitigationProductResponse; export import SummaryGetParams = SummaryAPI.SummaryGetParams; export import SummaryHTTPMethodParams = SummaryAPI.SummaryHTTPMethodParams; export import SummaryHTTPVersionParams = SummaryAPI.SummaryHTTPVersionParams; export import SummaryIPVersionParams = SummaryAPI.SummaryIPVersionParams; export import SummaryManagedRulesParams = SummaryAPI.SummaryManagedRulesParams; export import SummaryMitigationProductParams = SummaryAPI.SummaryMitigationProductParams; } //# sourceMappingURL=summary.d.ts.map