Get latest annotations
Retrieves the latest annotations.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Accepted Permissions (at least one required)
Parameters
Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.
End of the date range (inclusive). Alternative to dateRange; provide together with dateStart.
Filters results by a relative date range ending at the current time. Use <n>d for days (up to 364d) or <n>w for weeks (up to 52w), e.g. 7d. Append control to request the equivalent previous period for comparison: the comparison window is shifted back by the current window’s length rounded up to a whole number of weeks, so it keeps the same weekday alignment and does not overlap the current window (e.g. 3dcontrol covers days -10 to -7, 7dcontrol covers days -14 to -7, 28dcontrol covers days -56 to -28, and 10dcontrol covers days -24 to -14). Mutually exclusive with dateStart/dateEnd.
Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd.
Filters results by location. Specify an alpha-2 location code.
Get latest annotations
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
annotations = client.radar.annotations.list()
print(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
}