Skip to content
Cloudflare API
Start here
API Reference

Radar

RadarAgent Readiness

Get agent readiness summary
client.radar.agentReadiness.summary("CHECK"dimension, AgentReadinessSummaryParams { date, domainCategory, format, name } query?, RequestOptionsoptions?): AgentReadinessSummaryResponse { meta, summary_0 }
GET/radar/agent_readiness/summary/{dimension}
ModelsExpand Collapse
AgentReadinessSummaryResponse { meta, summary_0 }
meta: Meta { date, domainCategories, lastUpdated, 4 more }
date: string

Date of the returned scan (YYYY-MM-DD). May differ from the requested date if no scan exists for that exact date.

domainCategories: Array<DomainCategory>

Available domain sub-categories with their scan counts. Use as filter options for the domainCategory parameter.

name: string

Sub-category name.

value: number

Number of successfully scanned domains in this sub-category.

lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
successfulDomains: number

Domains successfully scanned (excludes errors).

totalDomains: number

Total domains attempted in the scan.

units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>

RadarAI

RadarAITo Markdown

Convert Files into Markdown
Deprecated
client.radar.ai.toMarkdown.create(ToMarkdownCreateParams { account_id, files } params, RequestOptionsoptions?): SinglePage<ToMarkdownCreateResponse { data, format, mimeType, 2 more } >
POST/accounts/{account_id}/ai/tomarkdown
ModelsExpand Collapse
ToMarkdownCreateResponse { data, format, mimeType, 2 more }
data: string
format: string
mimeType: string
name: string
tokens: string

RadarAIInference

Get Workers AI inference distribution by dimension
client.radar.ai.inference.summaryV2("MODEL" | "TASK"dimension, InferenceSummaryV2Params { asn, continent, dateEnd, 6 more } query?, RequestOptionsoptions?): InferenceSummaryV2Response { meta, summary_0 }
GET/radar/ai/inference/summary/{dimension}
Get time series distribution of Workers AI inference by dimension.
client.radar.ai.inference.timeseriesGroupsV2("MODEL" | "TASK"dimension, InferenceTimeseriesGroupsV2Params { aggInterval, asn, continent, 8 more } query?, RequestOptionsoptions?): InferenceTimeseriesGroupsV2Response { meta, serie_0 }
GET/radar/ai/inference/timeseries_groups/{dimension}
ModelsExpand Collapse
InferenceSummaryV2Response { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>
InferenceTimeseriesGroupsV2Response { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: Serie0 { timestamps }
timestamps: Array<string>

RadarAIInferenceSummary

Get Workers AI models summary
Deprecated
client.radar.ai.inference.summary.model(SummaryModelParams { dateEnd, dateRange, dateStart, 3 more } query?, RequestOptionsoptions?): SummaryModelResponse { meta, summary_0 }
GET/radar/ai/inference/summary/model
Get Workers AI tasks summary
Deprecated
client.radar.ai.inference.summary.task(SummaryTaskParams { dateEnd, dateRange, dateStart, 3 more } query?, RequestOptionsoptions?): SummaryTaskResponse { meta, summary_0 }
GET/radar/ai/inference/summary/task
ModelsExpand Collapse
SummaryModelResponse { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>
SummaryTaskResponse { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>

RadarAIInferenceTimeseries Groups

RadarAIInferenceTimeseries GroupsSummary

Get Workers AI models time series
Deprecated
client.radar.ai.inference.timeseriesGroups.summary.model(SummaryModelParams { aggInterval, dateEnd, dateRange, 4 more } query?, RequestOptionsoptions?): SummaryModelResponse { meta, serie_0 }
GET/radar/ai/inference/timeseries_groups/model
Get Workers AI tasks time series
Deprecated
client.radar.ai.inference.timeseriesGroups.summary.task(SummaryTaskParams { aggInterval, dateEnd, dateRange, 4 more } query?, RequestOptionsoptions?): SummaryTaskResponse { meta, serie_0 }
GET/radar/ai/inference/timeseries_groups/task
ModelsExpand Collapse
SummaryModelResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: Serie0 { timestamps }
timestamps: Array<string>
SummaryTaskResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: Serie0 { timestamps }
timestamps: Array<string>

RadarAIBots

Get AI bots HTTP requests distribution by dimension
client.radar.ai.bots.summaryV2("USER_AGENT" | "CRAWL_PURPOSE" | "INDUSTRY" | 4 moredimension, BotSummaryV2Params { asn, contentType, continent, 13 more } query?, RequestOptionsoptions?): BotSummaryV2Response { meta, summary_0 }
GET/radar/ai/bots/summary/{dimension}
Get AI bots HTTP requests time series
client.radar.ai.bots.timeseries(BotTimeseriesParams { aggInterval, asn, contentType, 14 more } query?, RequestOptionsoptions?): BotTimeseriesResponse { meta }
GET/radar/ai/bots/timeseries
Get time series distribution of AI bots HTTP requests by dimension.
client.radar.ai.bots.timeseriesGroups("USER_AGENT" | "CRAWL_PURPOSE" | "INDUSTRY" | 4 moredimension, BotTimeseriesGroupsParams { aggInterval, asn, contentType, 15 more } query?, RequestOptionsoptions?): BotTimeseriesGroupsResponse { meta, serie_0 }
GET/radar/ai/bots/timeseries_groups/{dimension}
ModelsExpand Collapse
BotSummaryV2Response { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>
BotTimeseriesResponse { meta }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
BotTimeseriesGroupsResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: Serie0 { timestamps }
timestamps: Array<string>

RadarAIBotsSummary

Get AI user agents summary
Deprecated
client.radar.ai.bots.summary.userAgent(SummaryUserAgentParams { asn, continent, dateEnd, 6 more } query?, RequestOptionsoptions?): SummaryUserAgentResponse { meta, summary_0 }
GET/radar/ai/bots/summary/user_agent
ModelsExpand Collapse
SummaryUserAgentResponse { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>

RadarAITimeseries Groups

Get AI user agents time series
Deprecated
client.radar.ai.timeseriesGroups.userAgent(TimeseriesGroupUserAgentParams { aggInterval, asn, continent, 7 more } query?, RequestOptionsoptions?): TimeseriesGroupUserAgentResponse { meta, serie_0 }
GET/radar/ai/bots/timeseries_groups/user_agent
Get AI bots HTTP requests distribution by dimension
Deprecated
client.radar.ai.timeseriesGroups.summary("USER_AGENT" | "CRAWL_PURPOSE" | "INDUSTRY" | 4 moredimension, TimeseriesGroupSummaryParams { asn, contentType, continent, 13 more } query?, RequestOptionsoptions?): TimeseriesGroupSummaryResponse { meta, summary_0 }
GET/radar/ai/bots/summary/{dimension}
Get AI bots HTTP requests time series
Deprecated
client.radar.ai.timeseriesGroups.timeseries(TimeseriesGroupTimeseriesParams { aggInterval, asn, contentType, 14 more } query?, RequestOptionsoptions?): TimeseriesGroupTimeseriesResponse { meta }
GET/radar/ai/bots/timeseries
Get time series distribution of AI bots HTTP requests by dimension.
Deprecated
client.radar.ai.timeseriesGroups.timeseriesGroups("USER_AGENT" | "CRAWL_PURPOSE" | "INDUSTRY" | 4 moredimension, TimeseriesGroupTimeseriesGroupsParams { aggInterval, asn, contentType, 15 more } query?, RequestOptionsoptions?): TimeseriesGroupTimeseriesGroupsResponse { meta, serie_0 }
GET/radar/ai/bots/timeseries_groups/{dimension}
ModelsExpand Collapse
TimeseriesGroupUserAgentResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: Serie0 { timestamps }
timestamps: Array<string>
TimeseriesGroupSummaryResponse { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string>
TimeseriesGroupTimeseriesResponse { meta }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
TimeseriesGroupTimeseriesGroupsResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: Serie0 { timestamps }
timestamps: Array<string>

RadarAIMarkdown For Agents

Get AI markdown for agents reduction ratio summary
client.radar.ai.markdownForAgents.summary(MarkdownForAgentSummaryParams { dateEnd, dateRange, dateStart, 2 more } query?, RequestOptionsoptions?): MarkdownForAgentSummaryResponse { meta, summary_0 }
GET/radar/ai/markdown_for_agents/summary
Get AI markdown for agents reduction ratio time series
client.radar.ai.markdownForAgents.timeseries(MarkdownForAgentTimeseriesParams { aggInterval, dateEnd, dateRange, 3 more } query?, RequestOptionsoptions?): MarkdownForAgentTimeseriesResponse { meta }
GET/radar/ai/markdown_for_agents/timeseries
ModelsExpand Collapse
MarkdownForAgentSummaryResponse { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Summary0 { value }
value: string

A numeric string that can include decimals and infinity values.

MarkdownForAgentTimeseriesResponse { meta }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string

RadarCT

Get certificate distribution by dimension
client.radar.ct.summary("CA" | "CA_OWNER" | "DURATION" | 11 moredimension, CTSummaryParams { ca, caOwner, dateEnd, 19 more } query?, RequestOptionsoptions?): CTSummaryResponse { meta, summary_0 }
GET/radar/ct/summary/{dimension}
Get certificates time series
client.radar.ct.timeseries(CTTimeseriesParams { aggInterval, ca, caOwner, 18 more } query?, RequestOptionsoptions?): CTTimeseriesResponse { meta }
GET/radar/ct/timeseries
Get time series of certificate distribution by dimension
client.radar.ct.timeseriesGroups("CA" | "CA_OWNER" | "DURATION" | 11 moredimension, CTTimeseriesGroupsParams { aggInterval, ca, caOwner, 20 more } query?, RequestOptionsoptions?): CTTimeseriesGroupsResponse { meta, serie_0 }
GET/radar/ct/timeseries_groups/{dimension}
ModelsExpand Collapse
CTSummaryResponse { meta, summary_0 }
meta: Meta { confidenceInfo, dateRange, lastUpdated, 2 more }

Metadata for the results.

confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
summary_0: Record<string, string> | UnionMember1 { rfc6962, static } | UnionMember2 { gt_121d, gt_16d_lte_31d, gt_31d_lte_91d, 3 more } | 5 more
One of the following:
Record<string, string>
UnionMember1 { rfc6962, static }
rfc6962: string
static: string
UnionMember2 { gt_121d, gt_16d_lte_31d, gt_31d_lte_91d, 3 more }
gt_121d: string
gt_16d_lte_31d: string
gt_31d_lte_91d: string
gt_3d_lte_16d: string
gt_91d_lte_121d: string
lte_3d: string
UnionMember3 { CERTIFICATE, PRECERTIFICATE }
CERTIFICATE: string
PRECERTIFICATE: string
UnionMember4 { EXPIRED, VALID }
EXPIRED: string
VALID: string
UnionMember5 { NEGATIVE, POSITIVE }
NEGATIVE: string
POSITIVE: string
UnionMember6 { DSA, ECDSA, RSA }
DSA: string
ECDSA: string
RSA: string
UnionMember7 { domain, extended, organization, unknown }
domain: string
extended: string
organization: string
unknown: string
CTTimeseriesResponse { meta }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
CTTimeseriesGroupsResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, 3 more }

Metadata for the results.

aggInterval: "FIFTEEN_MINUTES" | "ONE_HOUR" | "ONE_DAY" | 2 more

Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to Aggregation intervals.

One of the following:
"FIFTEEN_MINUTES"
"ONE_HOUR"
"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string

Timestamp of the last dataset update.

formatdate-time
normalization: "PERCENTAGE" | "MIN0_MAX" | "MIN_MAX" | 5 more

Normalization method applied to the results. Refer to Normalization methods.

One of the following:
"PERCENTAGE"
"MIN0_MAX"
"MIN_MAX"
"RAW_VALUES"
"PERCENTAGE_CHANGE"
"ROLLING_AVERAGE"
"OVERLAPPED_PERCENTAGE"
"RATIO"
units: Array<Unit>

Measurement units for the results.

name: string
value: string
serie_0: UnnamedSchemaRef7826220e105d84352ba1108d9ed88e55 { timestamps } | UnionMember1 { rfc6962, static } | UnionMember2 { gt_121d, gt_16d_lte_31d, gt_31d_lte_91d, 3 more } | 5 more
One of the following:
UnnamedSchemaRef7826220e105d84352ba1108d9ed88e55 { timestamps }
timestamps: Array<string>
UnionMember1 { rfc6962, static }
rfc6962: Array<string>
static: Array<string>
UnionMember2 { gt_121d, gt_16d_lte_31d, gt_31d_lte_91d, 3 more }
gt_121d: Array<string>
gt_16d_lte_31d: Array<string>
gt_31d_lte_91d: Array<string>
gt_3d_lte_16d: Array<string>
gt_91d_lte_121d: Array<string>
lte_3d: Array<string>
UnionMember3 { CERTIFICATE, PRECERTIFICATE }
CERTIFICATE: Array<string>
PRECERTIFICATE: Array<string>
UnionMember4 { EXPIRED, VALID }
EXPIRED: Array<string>
VALID: Array<string>
UnionMember5 { NEGATIVE, POSITIVE }
NEGATIVE: Array<string>
POSITIVE: Array<string>
UnionMember6 { DSA, ECDSA, RSA }
DSA: Array<string>
ECDSA: Array<string>
RSA: Array<string>
UnionMember7 { domain, extended, organization, unknown }
domain: Array<string>
extended: Array<string>
organization: Array<string>
unknown: Array<string>

RadarCTAuthorities

Get certificate authority details
client.radar.ct.authorities.get(stringcaSlug, AuthorityGetParams { format } query?, RequestOptionsoptions?): AuthorityGetResponse { certificateAuthority }
GET/radar/ct/authorities/{ca_slug}
List certificate authorities
client.radar.ct.authorities.list(AuthorityListParams { format, limit, offset } query?, RequestOptionsoptions?): AuthorityListResponse { certificateAuthorities }
GET/radar/ct/authorities
ModelsExpand Collapse
AuthorityGetResponse { certificateAuthority }
certificateAuthority: CertificateAuthority { appleStatus, authorityKeyIdentifier, certificateRecordType, 15 more }
appleStatus: "INCLUDED" | "NOT_YET_INCLUDED" | "NOT_INCLUDED" | 4 more

The inclusion status of a Certificate Authority (CA) in the trust store.

One of the following:
"INCLUDED"
"NOT_YET_INCLUDED"
"NOT_INCLUDED"
"NOT_BEFORE"
"REMOVED"
"DISABLED"
"BLOCKED"
authorityKeyIdentifier: string

The authorityKeyIdentifier value extracted from the certificate PEM.

certificateRecordType: "ROOT_CERTIFICATE" | "INTERMEDIATE_CERTIFICATE"

Specifies the type of certificate in the trust chain.

One of the following:
"ROOT_CERTIFICATE"
"INTERMEDIATE_CERTIFICATE"
chromeStatus: "INCLUDED" | "NOT_YET_INCLUDED" | "NOT_INCLUDED" | 4 more

The inclusion status of a Certificate Authority (CA) in the trust store.

One of the following:
"INCLUDED"
"NOT_YET_INCLUDED"
"NOT_INCLUDED"
"NOT_BEFORE"
"REMOVED"
"DISABLED"
"BLOCKED"
country: string

The two-letter ISO country code where the CA organization is based.

countryName: string

The full country name corresponding to the country code.

microsoftStatus: "INCLUDED" | "NOT_YET_INCLUDED" | "NOT_INCLUDED" | 4 more

The inclusion status of a Certificate Authority (CA) in the trust store.

One of the following:
"INCLUDED"
"NOT_YET_INCLUDED"
"NOT_INCLUDED"
"NOT_BEFORE"
"REMOVED"
"DISABLED"
"BLOCKED"
mozillaStatus: "INCLUDED" | "NOT_YET_INCLUDED" | "NOT_INCLUDED" | 4 more

The inclusion status of a Certificate Authority (CA) in the trust store.

One of the following:
"INCLUDED"
"NOT_YET_INCLUDED"
"NOT_INCLUDED"
"NOT_BEFORE"
"REMOVED"
"DISABLED"
"BLOCKED"
name: string

The full name of the certificate authority (CA).

owner: string

The organization that owns and operates the CA.

parentName: string

The name of the parent/root certificate authority that issued this intermediate certificate.

parentSha256Fingerprint: string

The SHA-256 fingerprint of the parent certificate.

One of the following:
One of the following:
revocationStatus: "NOT_REVOKED" | "REVOKED" | "PARENT_CERT_REVOKED"

The current revocation status of a Certificate Authority (CA) certificate.

One of the following:
"NOT_REVOKED"
"REVOKED"
"PARENT_CERT_REVOKED"
sha256Fingerprint: string

The SHA-256 fingerprint of the intermediate certificate.

subjectKeyIdentifier: string

The subjectKeyIdentifier value extracted from the certificate PEM.

validFrom: string

The start date of the certificate’s validity period (ISO format).

validTo: string

The end date of the certificate’s validity period (ISO format).

AuthorityListResponse { certificateAuthorities }
certificateAuthorities: Array<CertificateAuthority>
certificateRecordType: "ROOT_CERTIFICATE" | "INTERMEDIATE_CERTIFICATE"

Specifies the type of certificate in the trust chain.

One of the following:
"ROOT_CERTIFICATE"
"INTERMEDIATE_CERTIFICATE"
country: string

The two-letter ISO country code where the CA organization is based.

countryName: string

The full country name corresponding to the country code.

name: string

The full name of the certificate authority (CA).

owner: string

The organization that owns and operates the CA.

parentName: string

The name of the parent/root certificate authority that issued this intermediate certificate.

parentSha256Fingerprint: string

The SHA-256 fingerprint of the parent certificate.

revocationStatus: "NOT_REVOKED" | "REVOKED" | "PARENT_CERT_REVOKED"

The current revocation status of a Certificate Authority (CA) certificate.

One of the following:
"NOT_REVOKED"
"REVOKED"
"PARENT_CERT_REVOKED"
sha256Fingerprint: string

The SHA-256 fingerprint of the intermediate certificate.

RadarCTLogs

Get certificate log details
client.radar.ct.logs.get(stringlogSlug, LogGetParams { format } query?, RequestOptionsoptions?): LogGetResponse { certificateLog }
GET/radar/ct/logs/{log_slug}
List certificate logs
client.radar.ct.logs.list(LogListParams { format, limit, offset } query?, RequestOptionsoptions?): LogListResponse { certificateLogs }
GET/radar/ct/logs
ModelsExpand Collapse
LogGetResponse { certificateLog }
certificateLog: CertificateLog { api, avgThroughput, description, 12 more }
api: "RFC6962" | "STATIC"

The API standard that the certificate log follows.

One of the following:
"RFC6962"
"STATIC"
avgThroughput: number

The average throughput of the CT log, measured in certificates per hour (certs/hour).

description: string

A brief description of the certificate log.

endExclusive: string

The end date and time for when the log will stop accepting certificates.

formatdate-time
lastUpdate: string

Timestamp of the most recent update to the CT log.

formatdate-time
operator: string

The organization responsible for operating the certificate log.

performance: Performance | null

Log performance metrics, including averages and per-endpoint details.

endpoints: Array<Endpoint>
endpoint: "add-chain (new)" | "add-chain (old)" | "add-pre-chain (new)" | 4 more

The certificate log endpoint names used in performance metrics.

One of the following:
"add-chain (new)"
"add-chain (old)"
"add-pre-chain (new)"
"add-pre-chain (old)"
"get-entries"
"get-roots"
"get-sth"
responseTime: number
uptime: number
responseTime: number
uptime: number
One of the following:
slug: string

A URL-friendly, kebab-case identifier for the certificate log.

startInclusive: string

The start date and time for when the log starts accepting certificates.

formatdate-time
state: "USABLE" | "PENDING" | "QUALIFIED" | 3 more

The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html

One of the following:
"USABLE"
"PENDING"
"QUALIFIED"
"READ_ONLY"
"RETIRED"
"REJECTED"
stateTimestamp: string

Timestamp of when the log state was last updated.

formatdate-time
submittableCertCount: string | null

Number of certificates that are eligible for inclusion to this log but have not been included yet. Based on certificates signed by trusted root CAs within the log’s accepted date range.

submittedCertCount: string | null

Number of certificates already included in this CT log.

url: string

The URL for the certificate log.

LogListResponse { certificateLogs }
certificateLogs: Array<CertificateLog>
api: "RFC6962" | "STATIC"

The API standard that the certificate log follows.

One of the following:
"RFC6962"
"STATIC"
description: string

A brief description of the certificate log.

endExclusive: string

The end date and time for when the log will stop accepting certificates.

formatdate-time
operator: string

The organization responsible for operating the certificate log.

slug: string

A URL-friendly, kebab-case identifier for the certificate log.

startInclusive: string

The start date and time for when the log starts accepting certificates.

formatdate-time
state: "USABLE" | "PENDING" | "QUALIFIED" | 3 more

The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html

One of the following:
"USABLE"
"PENDING"
"QUALIFIED"
"READ_ONLY"
"RETIRED"
"REJECTED"
stateTimestamp: string

Timestamp of when the log state was last updated.

formatdate-time
url: string

The URL for the certificate log.

RadarAnnotations

Get latest annotations
client.radar.annotations.list(AnnotationListParams { asn, dataSource, dateEnd, 8 more } query?, RequestOptionsoptions?): AnnotationListResponse { annotations }
GET/radar/annotations
ModelsExpand Collapse
AnnotationListResponse { annotations }
annotations: Array<Annotation>
id: string
asns: Array<number>
asnsDetails: Array<ASNsDetail>
asn: string
name: string
locations?: Locations { code, name }
code: string
name: string
dataSource: string
eventType: string
locations: Array<string>
locationsDetails: Array<LocationsDetail>
code: string
name: string
origins: Array<string>
originsDetails: Array<OriginsDetail>
name: string
origin: string
outage: Outage { outageCause, outageType }
outageCause: string
outageType: string
startDate: string
description?: string
endDate?: string
linkedUrl?: string
scope?: string

RadarAnnotationsOutages

Get latest Internet outages and anomalies
client.radar.annotations.outages.get(OutageGetParams { asn, dateEnd, dateRange, 6 more } query?, RequestOptionsoptions?): OutageGetResponse { annotations }
GET/radar/annotations/outages
Get the number of outages by location
client.radar.annotations.outages.locations(OutageLocationsParams { dateEnd, dateRange, dateStart, 2 more } query?, RequestOptionsoptions?): OutageLocationsResponse { annotations }
GET/radar/annotations/outages/locations
ModelsExpand Collapse
OutageGetResponse { annotations }
annotations: Array<Annotation>
id: string
asns: Array<number>
asnsDetails: Array<ASNsDetail>
asn: string
name: string
locations?: Locations { code, name }
code: string
name: string
dataSource: string
eventType: string
locations: Array<string>
locationsDetails: Array<LocationsDetail>
code: string
name: string
origins: Array<string>
originsDetails: Array<OriginsDetail>
name: string
origin: string
outage: Outage { outageCause, outageType }
outageCause: string
outageType: string
startDate: string
formatdate-time
description?: string
endDate?: string
formatdate-time
linkedUrl?: string
scope?: string
OutageLocationsResponse { annotations }
annotations: Array<Annotation>
clientCountryAlpha2: string
clientCountryName: string
value: string

A numeric string.

RadarBGP

Get BGP time series
client.radar.bgp.timeseries(BGPTimeseriesParams { aggInterval, asn, dateEnd, 6 more } query?, RequestOptionsoptions?): BGPTimeseriesResponse { meta, serie_0 }
GET/radar/bgp/timeseries
ModelsExpand Collapse
BGPTimeseriesResponse { meta, serie_0 }
meta: Meta { aggInterval, confidenceInfo, dateRange, lastUpdated }
aggInterval: "15m" | "1h" | "1d" | "1w"
One of the following:
"15m"
"1h"
"1d"
"1w"
confidenceInfo: ConfidenceInfo { annotations, level }
annotations: Array<Annotation>
dataSource: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Data source for annotations.

One of the following:
"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
formatdate-time
eventType: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Event type for annotations.

One of the following:
"EVENT"
"GENERAL"
"OUTAGE"
"PARTIAL_PROJECTION"
"PIPELINE"
"TRAFFIC_ANOMALY"
isInstantaneous: boolean

Whether event is a single point in time or a time range.

linkedUrl: string
formaturi
startDate: string
formatdate-time
level: number

Provides an indication of how much confidence Cloudflare has in the data.

dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
lastUpdated: string
formatdate-time
serie_0: Serie0 { timestamps, values }
timestamps: Array<string>
values: Array<string>

RadarBGPLeaks

RadarBGPLeaksEvents

Get BGP route leak events
client.radar.bgp.leaks.events.list(EventListParams { dateEnd, dateRange, dateStart, 9 more } query?, RequestOptionsoptions?): V4PagePagination<EventListResponse { asn_info, events } >
GET/radar/bgp/leaks/events
ModelsExpand Collapse
EventListResponse { asn_info, events }
asn_info: Array<ASNInfo>
asn: number
country_code: string
org_name: string
events: Array<Event>
id: number
countries: Array<string>
detected_ts: string
finished: boolean
leak_asn: number
leak_count: number
leak_seg: Array<number>
leak_type: number
max_ts: string
min_ts: string
origin_count: number
peer_count: number
prefix_count: number

RadarBGPTop

Get top prefixes by BGP updates
client.radar.bgp.top.prefixes(TopPrefixesParams { asn, dateEnd, dateRange, 5 more } query?, RequestOptionsoptions?): TopPrefixesResponse { meta, top_0 }
GET/radar/bgp/top/prefixes
ModelsExpand Collapse
TopPrefixesResponse { meta, top_0 }
meta: Meta { dateRange }
dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
top_0: Array<Top0>
prefix: string
value: string

A numeric string.

RadarBGPTopAses

Get top ASes by BGP updates
client.radar.bgp.top.ases.get(AseGetParams { asn, dateEnd, dateRange, 6 more } query?, RequestOptionsoptions?): AseGetResponse { meta, top_0 }
GET/radar/bgp/top/ases
Get top ASes by prefix count
client.radar.bgp.top.ases.prefixes(AsePrefixesParams { country, format, limit } query?, RequestOptionsoptions?): AsePrefixesResponse { asns, meta }
GET/radar/bgp/top/ases/prefixes
ModelsExpand Collapse
AseGetResponse { meta, top_0 }
meta: Meta { dateRange }
dateRange: Array<DateRange>
endTime: string

Adjusted end of date range.

formatdate-time
startTime: string

Adjusted start of date range.

formatdate-time
top_0: Array<Top0>
asn: number
ASName: string
value: string

Percentage of updates by this AS out of the total updates by all autonomous systems.

AsePrefixesResponse { asns, meta }
asns: Array<ASN>
asn: number
country: string
name: string
pfxs_count: number
meta: Meta { data_time, query_time, total_peers }
data_time: string
query_time: string
total_peers: number

RadarBGPHijacks

RadarBGPHijacksEvents

Get BGP hijack events
client.radar.bgp.hijacks.events.list(EventListParams { dateEnd, dateRange, dateStart, 13 more } query?, RequestOptionsoptions?): V4PagePagination<EventListResponse { asn_info, events, total_monitors } >
GET/radar/bgp/hijacks/events
ModelsExpand Collapse
EventListResponse { asn_info, events, total_monitors }
asn_info: Array<ASNInfo>
asn: number
country_code: string
org_name: string
events: Array<Event>
id: number
confidence_score: number
duration: number
event_type: number
hijack_msgs_count: number
hijacker_asn: number
hijacker_country: string
is_stale: boolean
max_hijack_ts: string
max_msg_ts: string
min_hijack_ts: string
on_going_count: number
peer_asns: Array<number>
peer_ip_count: number
prefixes: Array<string>
tags: Array<Tag>
name: string
score: number
victim_asns: Array<number>
victim_countries: Array<string>
total_monitors: number

RadarBGPRoutes

Get Multi-Origin AS (MOAS) prefixes
client.radar.bgp.routes.moas(RouteMoasParams { format, invalid_only, origin, prefix } query?, RequestOptionsoptions?): RouteMoasResponse { meta, moas }
GET/radar/bgp/routes/moas
Get prefix-to-ASN mapping
client.radar.bgp.routes.pfx2as(RoutePfx2asParams { format, longestPrefixMatch, origin, 2 more } query?, RequestOptionsoptions?): RoutePfx2asResponse { meta, prefix_origins }
GET/radar/bgp/routes/pfx2as
Get BGP routing table stats
client.radar.bgp.routes.stats(RouteStatsParams { asn, format, location } query?, RequestOptionsoptions?): RouteStatsResponse { meta, stats }
GET/radar/bgp/routes/stats
List ASes from global routing tables
client.radar.bgp.routes.ases(RouteAsesParams { format, limit, location, 2 more } query?, RequestOptionsoptions?): RouteAsesResponse { asns, meta }
GET/radar/bgp/routes/ases
Get real-time BGP routes for a prefix
client.radar.bgp.routes.realtime(RouteRealtimeParams { format, prefix } query?, RequestOptionsoptions?): RouteRealtimeResponse { meta, routes }
GET/radar/bgp/routes/realtime
ModelsExpand Collapse
RouteMoasResponse { meta, moas }
meta: Meta { data_time, query_time, total_peers }
data_time: string
query_time: string
total_peers: number
moas: Array<Moa>
origins: Array<Origin>
origin: number
peer_count: number
rpki_validation: string
prefix: string
RoutePfx2asResponse { meta, prefix_origins }
meta: Meta { data_time, query_time, total_peers }
data_time: string
query_time: string
total_peers: number
prefix_origins: Array<PrefixOrigin>
origin: number
peer_count: number
prefix: string
rpki_validation: string
RouteStatsResponse { meta, stats }
meta: Meta { data_time, query_time, total_peers }
data_time: string
query_time: string
total_peers: number
stats: Stats { distinct_origins, distinct_origins_ipv4, distinct_origins_ipv6, 15 more }
distinct_origins: number
distinct_origins_ipv4: number
distinct_origins_ipv6: number
distinct_prefixes: number
distinct_prefixes_ipv4: number
distinct_prefixes_ipv6: number
routes_invalid: number
routes_invalid_ipv4: number
routes_invalid_ipv6: number
routes_total: number
routes_total_ipv4: number
routes_total_ipv6: number
routes_unknown: number
routes_unknown_ipv4: number
routes_unknown_ipv6: number
routes_valid: number
routes_valid_ipv4: number
routes_valid_ipv6: number
RouteAsesResponse { asns, meta }
asns: Array<ASN>
asn: number
coneSize: number

AS’s customer cone size.

country: string

Alpha-2 code for the AS’s registration country.

ipv4Count: number

Number of IPv4 addresses originated by the AS.

ipv6Count: string

Number of IPv6 addresses originated by the AS.

name: string

Name of the AS.

pfxsCount: number

Number of total IP prefixes originated by the AS.

rpkiInvalid: number

Number of RPKI invalid prefixes originated by the AS.

rpkiUnknown: number

Number of RPKI unknown prefixes originated by the AS.

rpkiValid: number

Number of RPKI valid prefixes originated by the AS.

meta: Meta { dataTime, queryTime, totalPeers }
dataTime: string

The timestamp of when the data is generated.

queryTime: string

The timestamp of the query.

totalPeers: number

Total number of route collector peers used to generate this data.

RouteRealtimeResponse { meta, routes }
meta: Meta { asn_info, collectors, data_time, 2 more }
asn_info: Array<ASNInfo>
as_name: string

Name of the autonomous system.

asn: number

AS number.

country_code: string

Alpha-2 code for the AS’s registration country.

org_id: string

Organization ID.

org_name: string

Organization name.

collectors: Array<Collector>
collector: string

Public route collector ID.

latest_realtime_ts: string

Latest real-time stream timestamp for this collector.

latest_rib_ts: string

Latest RIB dump MRT file timestamp for this collector.

latest_updates_ts: string

Latest BGP updates MRT file timestamp for this collector.

peers_count: number

Total number of collector peers used from this collector.

peers_v4_count: number

Total number of collector peers used from this collector for IPv4 prefixes.

peers_v6_count: number

Total number of collector peers used from this collector for IPv6 prefixes.

data_time: string

The most recent data timestamp for from the real-time sources.

prefix_origins: Array<PrefixOrigin>
origin: number

Origin ASN.

prefix: string

IP prefix of this query.

rpki_validation: string

Prefix-origin RPKI validation: valid, invalid, unknown.

total_peers: number

Total number of peers.

total_visible: number

Total number of peers seeing this prefix.

visibility: number

Ratio of peers seeing this prefix to total number of peers.

query_time: string

The timestamp of this query.

routes: Array<Route>
as_path: Array<number>

AS-level path for this route, from collector to origin.

collector: string

Public collector ID for this route.

communities: Array<string>

BGP community values.

prefix: string

IP prefix of this query.

timestamp: string

Latest timestamp of change for this route.