annotations

Creates, updates, deletes, gets or lists an annotations resource.

Overview

Name	annotations
Type	Resource
Id	cloudflare.radar.annotations

Fields

The following fields are returned by SELECT queries:

list

Successful response.

Name	Datatype	Description
id	string
asns	array
asnsDetails	array
dataSource	string
description	string
endDate	string
eventType	string
linkedUrl	string
locations	array
locationsDetails	array
origins	array
originsDetails	array
outage	object
scope	string
startDate	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select		limit, offset, dateRange, dateStart, dateEnd, dataSource, eventType, asn, location, origin, format	Retrieves the latest annotations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
asn	integer	Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
dataSource	string	Filters results by data source.
dateEnd	string (date-time)	End of the date range (inclusive).
dateRange	string	Filters results by date range.
dateStart	string (date-time)	Start of the date range (inclusive).
eventType	string	Filters results by event type.
format	string	Format in which results will be returned.
limit	integer	Limits the number of objects returned in the response.
location	string	Filters results by location. Specify an alpha-2 location code.
offset	integer	Skips the specified number of objects before fetching the results.
origin	string	Filters results by origin.

SELECT examples

list

Retrieves the latest annotations.

SELECT
id,
asns,
asnsDetails,
dataSource,
description,
endDate,
eventType,
linkedUrl,
locations,
locationsDetails,
origins,
originsDetails,
outage,
scope,
startDate
FROM cloudflare.radar.annotations
WHERE limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND dateRange = '{{ dateRange }}'
AND dateStart = '{{ dateStart }}'
AND dateEnd = '{{ dateEnd }}'
AND dataSource = '{{ dataSource }}'
AND eventType = '{{ eventType }}'
AND asn = '{{ asn }}'
AND location = '{{ location }}'
AND origin = '{{ origin }}'
AND format = '{{ format }}'
;