Get latest annotations

client.Radar.Annotations.List(ctx, query) (*AnnotationListResponse, error)

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 param.Field[int64]Optional

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

Bot param.Field[string]Optional

Filters results by bot.

maxLength100

CA param.Field[string]Optional

Filters results by certificate authority.

maxLength100

DataSource param.Field[AnnotationListParamsDataSource]Optional

Filters results by data source.

const AnnotationListParamsDataSourceAll AnnotationListParamsDataSource = "ALL"

const AnnotationListParamsDataSourceAIBots AnnotationListParamsDataSource = "AI_BOTS"

const AnnotationListParamsDataSourceAIGateway AnnotationListParamsDataSource = "AI_GATEWAY"

const AnnotationListParamsDataSourceBGP AnnotationListParamsDataSource = "BGP"

const AnnotationListParamsDataSourceBots AnnotationListParamsDataSource = "BOTS"

const AnnotationListParamsDataSourceConnectionAnomaly AnnotationListParamsDataSource = "CONNECTION_ANOMALY"

const AnnotationListParamsDataSourceCT AnnotationListParamsDataSource = "CT"

const AnnotationListParamsDataSourceDNS AnnotationListParamsDataSource = "DNS"

const AnnotationListParamsDataSourceDNSMagnitude AnnotationListParamsDataSource = "DNS_MAGNITUDE"

const AnnotationListParamsDataSourceDNSAS112 AnnotationListParamsDataSource = "DNS_AS112"

const AnnotationListParamsDataSourceDos AnnotationListParamsDataSource = "DOS"

const AnnotationListParamsDataSourceEmailRouting AnnotationListParamsDataSource = "EMAIL_ROUTING"

const AnnotationListParamsDataSourceEmailSecurity AnnotationListParamsDataSource = "EMAIL_SECURITY"

const AnnotationListParamsDataSourceFw AnnotationListParamsDataSource = "FW"

const AnnotationListParamsDataSourceFwPg AnnotationListParamsDataSource = "FW_PG"

const AnnotationListParamsDataSourceHTTP AnnotationListParamsDataSource = "HTTP"

const AnnotationListParamsDataSourceHTTPControl AnnotationListParamsDataSource = "HTTP_CONTROL"

const AnnotationListParamsDataSourceHTTPCrawlerReferer AnnotationListParamsDataSource = "HTTP_CRAWLER_REFERER"

const AnnotationListParamsDataSourceHTTPOrigins AnnotationListParamsDataSource = "HTTP_ORIGINS"

const AnnotationListParamsDataSourceIQI AnnotationListParamsDataSource = "IQI"

const AnnotationListParamsDataSourceLeakedCredentials AnnotationListParamsDataSource = "LEAKED_CREDENTIALS"

const AnnotationListParamsDataSourceNet AnnotationListParamsDataSource = "NET"

const AnnotationListParamsDataSourceRobotsTXT AnnotationListParamsDataSource = "ROBOTS_TXT"

const AnnotationListParamsDataSourceSpeed AnnotationListParamsDataSource = "SPEED"

const AnnotationListParamsDataSourceWorkersAI AnnotationListParamsDataSource = "WORKERS_AI"

DateEnd param.Field[Time]Optional

End of the date range (inclusive). Alternative to dateRange; provide together with dateStart.

formatdate-time

DateRange param.Field[string]Optional

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.

DateStart param.Field[Time]Optional

Start of the date range (inclusive). Alternative to dateRange; provide together with dateEnd.

formatdate-time

EventType param.Field[AnnotationListParamsEventType]Optional

Filters results by event type. EVENT is a legacy alias for GENERAL.

const AnnotationListParamsEventTypeEvent AnnotationListParamsEventType = "EVENT"

const AnnotationListParamsEventTypeGeneral AnnotationListParamsEventType = "GENERAL"

const AnnotationListParamsEventTypeOutage AnnotationListParamsEventType = "OUTAGE"

const AnnotationListParamsEventTypePartialProjection AnnotationListParamsEventType = "PARTIAL_PROJECTION"

const AnnotationListParamsEventTypePipeline AnnotationListParamsEventType = "PIPELINE"

const AnnotationListParamsEventTypeTrafficAnomaly AnnotationListParamsEventType = "TRAFFIC_ANOMALY"

Format param.Field[AnnotationListParamsFormat]Optional

Format in which results will be returned.

const AnnotationListParamsFormatJson AnnotationListParamsFormat = "JSON"

const AnnotationListParamsFormatCsv AnnotationListParamsFormat = "CSV"

GeoID param.Field[string]Optional

Filters results by geolocation. Refer to GeoNames.

maxLength100

Limit param.Field[int64]Optional

Limits the number of objects returned in the response.

exclusiveMinimum

minimum0

Location param.Field[string]Optional

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

maxLength2

minLength2

Log param.Field[string]Optional

Filters results by certificate log.

maxLength100

Offset param.Field[int64]Optional

Skips the specified number of objects before fetching the results.

minimum0

Origin param.Field[string]Optional

Filters results by origin.

maxLength100

OutageCause param.Field[AnnotationListParamsOutageCause]Optional

Filters results by outage cause.

const AnnotationListParamsOutageCauseBlocking AnnotationListParamsOutageCause = "BLOCKING"

const AnnotationListParamsOutageCauseCableCut AnnotationListParamsOutageCause = "CABLE_CUT"

const AnnotationListParamsOutageCauseCyberattack AnnotationListParamsOutageCause = "CYBERATTACK"

const AnnotationListParamsOutageCauseDNS AnnotationListParamsOutageCause = "DNS"

const AnnotationListParamsOutageCauseFire AnnotationListParamsOutageCause = "FIRE"

const AnnotationListParamsOutageCauseGovernmentDirected AnnotationListParamsOutageCause = "GOVERNMENT_DIRECTED"

const AnnotationListParamsOutageCauseMaintenance AnnotationListParamsOutageCause = "MAINTENANCE"

const AnnotationListParamsOutageCauseMechanical AnnotationListParamsOutageCause = "MECHANICAL"

const AnnotationListParamsOutageCauseMilitaryAction AnnotationListParamsOutageCause = "MILITARY_ACTION"

const AnnotationListParamsOutageCauseMisconfiguration AnnotationListParamsOutageCause = "MISCONFIGURATION"

const AnnotationListParamsOutageCauseNaturalDisaster AnnotationListParamsOutageCause = "NATURAL_DISASTER"

const AnnotationListParamsOutageCauseNetworkProblem AnnotationListParamsOutageCause = "NETWORK_PROBLEM"

const AnnotationListParamsOutageCausePowerOutage AnnotationListParamsOutageCause = "POWER_OUTAGE"

const AnnotationListParamsOutageCauseSoftware AnnotationListParamsOutageCause = "SOFTWARE"

const AnnotationListParamsOutageCauseTechnicalProblem AnnotationListParamsOutageCause = "TECHNICAL_PROBLEM"

const AnnotationListParamsOutageCauseUnknown AnnotationListParamsOutageCause = "UNKNOWN"

const AnnotationListParamsOutageCauseWeather AnnotationListParamsOutageCause = "WEATHER"

OutageType param.Field[AnnotationListParamsOutageType]Optional

Filters results by outage type.

const AnnotationListParamsOutageTypeNationwide AnnotationListParamsOutageType = "NATIONWIDE"

const AnnotationListParamsOutageTypeRegional AnnotationListParamsOutageType = "REGIONAL"

const AnnotationListParamsOutageTypeNetwork AnnotationListParamsOutageType = "NETWORK"

const AnnotationListParamsOutageTypePlatform AnnotationListParamsOutageType = "PLATFORM"

Query param.Field[string]Optional

Filters results by a free-text match on the annotation description, id, or linked entities (location, ASN, origin).

maxLength100

Tags param.Field[[]AnnotationListParamsTag]Optional

Filters results by annotation tag. Matches annotations carrying at least one of the given tags.

const AnnotationListParamsTagAdm1 AnnotationListParamsTag = "ADM1"

const AnnotationListParamsTagAdm2 AnnotationListParamsTag = "ADM2"

const AnnotationListParamsTagAPITraffic AnnotationListParamsTag = "API_TRAFFIC"

const AnnotationListParamsTagARC AnnotationListParamsTag = "ARC"

const AnnotationListParamsTagAs AnnotationListParamsTag = "AS"

const AnnotationListParamsTagASN AnnotationListParamsTag = "ASN"

const AnnotationListParamsTagAttacks AnnotationListParamsTag = "ATTACKS"

const AnnotationListParamsTagAuthor AnnotationListParamsTag = "AUTHOR"

const AnnotationListParamsTagBandwidth AnnotationListParamsTag = "BANDWIDTH"

const AnnotationListParamsTagBitrate AnnotationListParamsTag = "BITRATE"

const AnnotationListParamsTagBot AnnotationListParamsTag = "BOT"

const AnnotationListParamsTagBotCategory AnnotationListParamsTag = "BOT_CATEGORY"

const AnnotationListParamsTagBotClass AnnotationListParamsTag = "BOT_CLASS"

const AnnotationListParamsTagBotKind AnnotationListParamsTag = "BOT_KIND"

const AnnotationListParamsTagBotOperator AnnotationListParamsTag = "BOT_OPERATOR"

const AnnotationListParamsTagBrowser AnnotationListParamsTag = "BROWSER"

const AnnotationListParamsTagBrowserFamily AnnotationListParamsTag = "BROWSER_FAMILY"

const AnnotationListParamsTagBytes AnnotationListParamsTag = "BYTES"

const AnnotationListParamsTagCA AnnotationListParamsTag = "CA"

const AnnotationListParamsTagCacheHit AnnotationListParamsTag = "CACHE_HIT"

const AnnotationListParamsTagCAOwner AnnotationListParamsTag = "CA_OWNER"

const AnnotationListParamsTagCheckResult AnnotationListParamsTag = "CHECK_RESULT"

const AnnotationListParamsTagClientType AnnotationListParamsTag = "CLIENT_TYPE"

const AnnotationListParamsTagCompromised AnnotationListParamsTag = "COMPROMISED"

const AnnotationListParamsTagContentType AnnotationListParamsTag = "CONTENT_TYPE"

const AnnotationListParamsTagCrawlPurpose AnnotationListParamsTag = "CRAWL_PURPOSE"

const AnnotationListParamsTagCrawlReferRatio AnnotationListParamsTag = "CRAWL_REFER_RATIO"

const AnnotationListParamsTagDeviceType AnnotationListParamsTag = "DEVICE_TYPE"

const AnnotationListParamsTagDKIM AnnotationListParamsTag = "DKIM"

const AnnotationListParamsTagDMARC AnnotationListParamsTag = "DMARC"

const AnnotationListParamsTagDNS AnnotationListParamsTag = "DNS"

const AnnotationListParamsTagDNSSEC AnnotationListParamsTag = "DNSSEC"

const AnnotationListParamsTagDNSSECAware AnnotationListParamsTag = "DNSSEC_AWARE"

const AnnotationListParamsTagDNSSECE2E AnnotationListParamsTag = "DNSSEC_E2E"

const AnnotationListParamsTagDomainCategory AnnotationListParamsTag = "DOMAIN_CATEGORY"

const AnnotationListParamsTagDuration AnnotationListParamsTag = "DURATION"

const AnnotationListParamsTagEdns AnnotationListParamsTag = "EDNS"

const AnnotationListParamsTagEncrypted AnnotationListParamsTag = "ENCRYPTED"

const AnnotationListParamsTagEntryType AnnotationListParamsTag = "ENTRY_TYPE"

const AnnotationListParamsTagExpirationStatus AnnotationListParamsTag = "EXPIRATION_STATUS"

const AnnotationListParamsTagHasIPs AnnotationListParamsTag = "HAS_IPS"

const AnnotationListParamsTagHasMatchingAnswer AnnotationListParamsTag = "HAS_MATCHING_ANSWER"

const AnnotationListParamsTagHasWildcards AnnotationListParamsTag = "HAS_WILDCARDS"

const AnnotationListParamsTagHTTPMethod AnnotationListParamsTag = "HTTP_METHOD"

const AnnotationListParamsTagHTTPProtocol AnnotationListParamsTag = "HTTP_PROTOCOL"

const AnnotationListParamsTagHTTPVersion AnnotationListParamsTag = "HTTP_VERSION"

const AnnotationListParamsTagIndustry AnnotationListParamsTag = "INDUSTRY"

const AnnotationListParamsTagIPVersion AnnotationListParamsTag = "IP_VERSION"

const AnnotationListParamsTagJitter AnnotationListParamsTag = "JITTER"

const AnnotationListParamsTagKeyAgreement AnnotationListParamsTag = "KEY_AGREEMENT"

const AnnotationListParamsTagLatency AnnotationListParamsTag = "LATENCY"

const AnnotationListParamsTagLocation AnnotationListParamsTag = "LOCATION"

const AnnotationListParamsTagLocationLatency AnnotationListParamsTag = "LOCATION_LATENCY"

const AnnotationListParamsTagLog AnnotationListParamsTag = "LOG"

const AnnotationListParamsTagLogAPI AnnotationListParamsTag = "LOG_API"

const AnnotationListParamsTagLogOperator AnnotationListParamsTag = "LOG_OPERATOR"

const AnnotationListParamsTagMalicious AnnotationListParamsTag = "MALICIOUS"

const AnnotationListParamsTagManagedRules AnnotationListParamsTag = "MANAGED_RULES"

const AnnotationListParamsTagMitigationProduct AnnotationListParamsTag = "MITIGATION_PRODUCT"

const AnnotationListParamsTagModel AnnotationListParamsTag = "MODEL"

const AnnotationListParamsTagNameserverLatency AnnotationListParamsTag = "NAMESERVER_LATENCY"

const AnnotationListParamsTagOrigin AnnotationListParamsTag = "ORIGIN"

const AnnotationListParamsTagOriginAs AnnotationListParamsTag = "ORIGIN_AS"

const AnnotationListParamsTagOriginLocation AnnotationListParamsTag = "ORIGIN_LOCATION"

const AnnotationListParamsTagOriginTargetLocationPair AnnotationListParamsTag = "ORIGIN_TARGET_LOCATION_PAIR"

const AnnotationListParamsTagOS AnnotationListParamsTag = "OS"

const AnnotationListParamsTagPercentile AnnotationListParamsTag = "PERCENTILE"

const AnnotationListParamsTagPostQuantum AnnotationListParamsTag = "POST_QUANTUM"

const AnnotationListParamsTagPrefix AnnotationListParamsTag = "PREFIX"

const AnnotationListParamsTagProduct AnnotationListParamsTag = "PRODUCT"

const AnnotationListParamsTagProtocol AnnotationListParamsTag = "PROTOCOL"

const AnnotationListParamsTagProvider AnnotationListParamsTag = "PROVIDER"

const AnnotationListParamsTagPublicKeyAlgorithm AnnotationListParamsTag = "PUBLIC_KEY_ALGORITHM"

const AnnotationListParamsTagQueryType AnnotationListParamsTag = "QUERY_TYPE"

const AnnotationListParamsTagReferer AnnotationListParamsTag = "REFERER"

const AnnotationListParamsTagRegion AnnotationListParamsTag = "REGION"

const AnnotationListParamsTagResponseCode AnnotationListParamsTag = "RESPONSE_CODE"

const AnnotationListParamsTagResponseStatus AnnotationListParamsTag = "RESPONSE_STATUS"

const AnnotationListParamsTagResponseStatusCategory AnnotationListParamsTag = "RESPONSE_STATUS_CATEGORY"

const AnnotationListParamsTagResponseTTL AnnotationListParamsTag = "RESPONSE_TTL"

const AnnotationListParamsTagSignatureAlgorithm AnnotationListParamsTag = "SIGNATURE_ALGORITHM"

const AnnotationListParamsTagSpam AnnotationListParamsTag = "SPAM"

const AnnotationListParamsTagSPF AnnotationListParamsTag = "SPF"

const AnnotationListParamsTagSpoof AnnotationListParamsTag = "SPOOF"

const AnnotationListParamsTagSuccessRate AnnotationListParamsTag = "SUCCESS_RATE"

const AnnotationListParamsTagTargetLocation AnnotationListParamsTag = "TARGET_LOCATION"

const AnnotationListParamsTagTask AnnotationListParamsTag = "TASK"

const AnnotationListParamsTagThreatCategory AnnotationListParamsTag = "THREAT_CATEGORY"

const AnnotationListParamsTagTLD AnnotationListParamsTag = "TLD"

const AnnotationListParamsTagTLDDNSMagnitude AnnotationListParamsTag = "TLD_DNS_MAGNITUDE"

const AnnotationListParamsTagTLSVersion AnnotationListParamsTag = "TLS_VERSION"

const AnnotationListParamsTagUpdateType AnnotationListParamsTag = "UPDATE_TYPE"

const AnnotationListParamsTagUserAgent AnnotationListParamsTag = "USER_AGENT"

const AnnotationListParamsTagValidationLevel AnnotationListParamsTag = "VALIDATION_LEVEL"

const AnnotationListParamsTagVector AnnotationListParamsTag = "VECTOR"

const AnnotationListParamsTagVertical AnnotationListParamsTag = "VERTICAL"

TLD param.Field[string]Optional

Filters results by top-level domain.

maxLength63

minLength2

ReturnsExpand Collapse

type AnnotationListResponse struct{…}

Annotations []AnnotationListResponseAnnotation

ID string

ASNs []int64

ASNsDetails []AnnotationListResponseAnnotationsASNsDetail

ASN string

Location AnnotationListResponseAnnotationsASNsDetailsLocation

Code string

Name string

DataSource string

Description string

EndDate string

Entities []AnnotationListResponseAnnotationsEntity

EntityName string

EntityType string

EntityValue string

EventType string

GeoIDs []string

LinkedURL string

Locations []string

LocationsDetails []AnnotationListResponseAnnotationsLocationsDetail

Code string

Name string

Origins []string

OriginsDetails []AnnotationListResponseAnnotationsOriginsDetail

Name string

Origin string

Outage AnnotationListResponseAnnotationsOutage

OutageCause string

OutageType string

Scope string

StartDate string

Tags []string

Get latest annotations

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  annotations, err := client.Radar.Annotations.List(context.TODO(), radar.AnnotationListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
}