Skip to content
Cloudflare API
Start here
API Reference
Radar

Annotations

Get latest annotations
client.radar.annotations.list(AnnotationListParams { asn, bot, ca, 17 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
location: Location | null
code: string
name: string
name: string | null
dataSource: string
description: string | null
endDate: string | null
entities: Array<Entity>
entityName: string | null
entityType: string
entityValue: string
eventType: string
geoIds: Array<string>
linkedUrl: string | null
locations: Array<string>
locationsDetails: Array<LocationsDetail | null>
code: string
name: string
origins: Array<string>
originsDetails: Array<OriginsDetail>
name: string | null
origin: string
outage: Outage | null
outageCause: string
outageType: string
scope: string | null
startDate: string
tags: Array<string>

AnnotationsOutages

Get latest Internet outages and anomalies
client.radar.annotations.outages.get(OutageGetParams { asn, bot, ca, 16 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
location: Location | null
code: string
name: string
name: string | null
dataSource: string
description: string | null
endDate: string | null
formatdate-time
entities: Array<Entity>
entityName: string | null
entityType: string
entityValue: string
eventType: string
geoIds: Array<string>
linkedUrl: string | null
locations: Array<string>
locationsDetails: Array<LocationsDetail | null>
code: string
name: string
origins: Array<string>
originsDetails: Array<OriginsDetail>
name: string | null
origin: string
outage: Outage | null
outageCause: string
outageType: string
scope: string | null
startDate: string
formatdate-time
tags: Array<string>
OutageLocationsResponse { annotations }
annotations: Array<Annotation>
clientCountryAlpha2: string
clientCountryName: string
value: string

A numeric string.