Get latest annotations

client.radar.annotations.list(?, ?): 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:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

query: AnnotationListParams { asn, dataSource, dateEnd, 8 more }

asn?: number

Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.

dataSource?: "ALL" | "AI_BOTS" | "AI_GATEWAY" | 22 more

Filters results by data source.

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"

dateEnd?: string

End of the date range (inclusive).

formatdate-time

dateRange?: string

Filters results by date range.

dateStart?: string

Start of the date range (inclusive).

formatdate-time

eventType?: "EVENT" | "GENERAL" | "OUTAGE" | 3 more

Filters results by event type.

One of the following:

"EVENT"

"GENERAL"

"OUTAGE"

"PARTIAL_PROJECTION"

"PIPELINE"

"TRAFFIC_ANOMALY"

format?: "JSON" | "CSV"

Format in which results will be returned.

One of the following:

"JSON"

"CSV"

limit?: number

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

location?: string

Filters results by location. Specify an alpha-2 location code.

maxLength2

minLength2

offset?: number

Skips the specified number of objects before fetching the results.

minimum0

origin?: string

Filters results by origin.

maxLength100

ReturnsExpand Collapse

AnnotationListResponse { annotations }

annotations: Array<Annotation>

id: string

asns: Array<number>

asnsDetails: Array<ASNsDetail>

asn: string

locations?: Locations { code, name }

code: string

dataSource: string

eventType: string

locations: Array<string>

locationsDetails: Array<LocationsDetail>

code: string

origins: Array<string>

originsDetails: Array<OriginsDetail>

origin: string

outage: Outage { outageCause, outageType }

outageCause: string

outageType: string

startDate: string

description?: string

endDate?: string

linkedUrl?: string

scope?: string

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",
            "name": "LUMEN-LEGACY-L3-PARTITION",
            "locations": {
              "code": "US",
              "name": "United States"
            }
          }
        ],
        "dataSource": "ALL",
        "eventType": "OUTAGE",
        "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"
        },
        "startDate": "2022-09-06T10:00:28Z",
        "description": "example",
        "endDate": "2022-09-08T10:00:28Z",
        "linkedUrl": "http://example.com",
        "scope": "Colima, Michoacán, México"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "result": {
    "annotations": [
      {
        "id": "550",
        "asns": [
          189
        ],
        "asnsDetails": [
          {
            "asn": "189",
            "name": "LUMEN-LEGACY-L3-PARTITION",
            "locations": {
              "code": "US",
              "name": "United States"
            }
          }
        ],
        "dataSource": "ALL",
        "eventType": "OUTAGE",
        "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"
        },
        "startDate": "2022-09-06T10:00:28Z",
        "description": "example",
        "endDate": "2022-09-08T10:00:28Z",
        "linkedUrl": "http://example.com",
        "scope": "Colima, Michoacán, México"
      }
    ]
  },
  "success": true
}