/radar/annotations/outages
get
Radar Annotations
radar-get-annotations-outages
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"com.cloudflare.api.user.read"
]
}[
{
"in": "query",
"name": "limit",
"schema": {
"description": "Limit the number of objects in the response.",
"example": 5,
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"schema": {
"description": "Number of objects to skip before grabbing results.",
"type": "integer"
}
},
{
"in": "query",
"name": "dateRange",
"schema": {
"description": "Shorthand date ranges for the last X days - use when you don't need specific start and end dates.",
"enum": [
"1d",
"2d",
"7d",
"14d",
"28d",
"12w",
"24w",
"52w",
"1dControl",
"2dControl",
"7dControl",
"14dControl",
"28dControl",
"12wControl",
"24wControl"
],
"example": "7d",
"type": "string"
}
},
{
"in": "query",
"name": "dateStart",
"schema": {
"description": "Start of the date range (inclusive).",
"example": "2023-09-01T11:41:33.782Z",
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "dateEnd",
"schema": {
"description": "End of the date range (inclusive).",
"example": "2023-09-01T11:41:33.782Z",
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "asn",
"schema": {
"description": "Single ASN as integer.",
"example": "174",
"type": "integer"
}
},
{
"in": "query",
"name": "location",
"schema": {
"description": "Location Alpha2 code.",
"example": "US",
"type": "string"
}
},
{
"in": "query",
"name": "format",
"schema": {
"description": "Format results are returned in.",
"enum": [
"JSON",
"CSV"
],
"example": "json",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"properties": {
"annotations": {
"items": {
"properties": {
"asns": {
"items": {
"example": 189,
"type": "integer"
},
"type": "array"
},
"asnsDetails": {
"items": {
"properties": {
"asn": {
"example": "189",
"type": "string"
},
"locations": {
"properties": {
"code": {
"example": "US",
"type": "string"
},
"name": {
"example": "United States",
"type": "string"
}
},
"required": [
"code",
"name"
],
"type": "object"
},
"name": {
"example": "LUMEN-LEGACY-L3-PARTITION",
"type": "string"
}
},
"required": [
"asn",
"name"
],
"type": "object"
},
"type": "array"
},
"dataSource": {
"example": "ALL",
"type": "string"
},
"description": {
"example": "example",
"type": "string"
},
"endDate": {
"example": "2022-09-08T10:00:28Z",
"type": "string"
},
"eventType": {
"example": "OUTAGE",
"type": "string"
},
"id": {
"example": "550",
"type": "string"
},
"linkedUrl": {
"example": "http://example.com",
"type": "string"
},
"locations": {
"items": {
"example": "US",
"type": "string"
},
"type": "array"
},
"locationsDetails": {
"items": {
"properties": {
"code": {
"example": "US",
"type": "string"
},
"name": {
"example": "United States",
"type": "string"
}
},
"required": [
"code",
"name"
],
"type": "object"
},
"type": "array"
},
"outage": {
"properties": {
"outageCause": {
"example": "CABLE_CUT",
"type": "string"
},
"outageType": {
"example": "NATIONWIDE",
"type": "string"
}
},
"required": [
"outageCause",
"outageType"
],
"type": "object"
},
"scope": {
"example": "Colima, Michoacán, México",
"type": "string"
},
"startDate": {
"example": "2022-09-06T10:00:28Z",
"type": "string"
}
},
"required": [
"id",
"dataSource",
"startDate",
"asns",
"asnsDetails",
"locations",
"locationsDetails",
"eventType",
"outage"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"annotations"
],
"type": "object"
},
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"result",
"success"
],
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"type": "object"
},
"success": {
"example": false,
"type": "boolean"
}
},
"required": [
"result",
"success",
"errors"
],
"type": "object"
}
}
},
"description": "Bad Request"
}
}[
{
"api_email": [],
"api_key": []
}
]