Get latest annotations
client.radar.annotations.list(AnnotationListParams { asn, bot, ca, 17 more } query?, RequestOptionsoptions?): AnnotationListResponse { annotations }
GET/radar/annotations
Retrieves the latest annotations.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Get latest annotations
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const annotations = await client.radar.annotations.list();
console.log(annotations.annotations);{
"result": {
"annotations": [
{
"id": "550",
"asns": [
189
],
"asnsDetails": [
{
"asn": "189",
"location": {
"code": "US",
"name": "United States"
},
"name": "LUMEN-LEGACY-L3-PARTITION"
}
],
"dataSource": "ALL",
"description": "example",
"endDate": "2022-09-08T10:00:28Z",
"entities": [
{
"entityName": "GPTBot",
"entityType": "BOT",
"entityValue": "gptbot"
}
],
"eventType": "OUTAGE",
"geoIds": [
"2267057"
],
"linkedUrl": "http://example.com",
"locations": [
"US"
],
"locationsDetails": [
{
"code": "US",
"name": "United States"
}
],
"origins": [
"amazon-us-east-1"
],
"originsDetails": [
{
"name": "us-east-1 Amazon Web Services",
"origin": "amazon-us-east-1"
}
],
"outage": {
"outageCause": "CABLE_CUT",
"outageType": "NATIONWIDE"
},
"scope": "Colima, Michoacán, México",
"startDate": "2022-09-06T10:00:28Z",
"tags": [
"string"
]
}
]
},
"success": true
}Returns Examples
{
"result": {
"annotations": [
{
"id": "550",
"asns": [
189
],
"asnsDetails": [
{
"asn": "189",
"location": {
"code": "US",
"name": "United States"
},
"name": "LUMEN-LEGACY-L3-PARTITION"
}
],
"dataSource": "ALL",
"description": "example",
"endDate": "2022-09-08T10:00:28Z",
"entities": [
{
"entityName": "GPTBot",
"entityType": "BOT",
"entityValue": "gptbot"
}
],
"eventType": "OUTAGE",
"geoIds": [
"2267057"
],
"linkedUrl": "http://example.com",
"locations": [
"US"
],
"locationsDetails": [
{
"code": "US",
"name": "United States"
}
],
"origins": [
"amazon-us-east-1"
],
"originsDetails": [
{
"name": "us-east-1 Amazon Web Services",
"origin": "amazon-us-east-1"
}
],
"outage": {
"outageCause": "CABLE_CUT",
"outageType": "NATIONWIDE"
},
"scope": "Colima, Michoacán, México",
"startDate": "2022-09-06T10:00:28Z",
"tags": [
"string"
]
}
]
},
"success": true
}