Get top ASes by network traffic

client.Radar.NetFlows.Top.Ases(ctx, query) (*NetFlowsTopAsesResponse, error)

GET/radar/netflows/top/ases

Retrieves the top autonomous systems by network traffic (NetFlows).

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 NetFlowsTopAsesParams

ASN param.Field[[]string]Optional

Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with - to exclude ASNs from results. For example, -174, 3356 excludes results from AS174, but includes results from AS3356.

Continent param.Field[[]string]Optional

Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with - to exclude continents from results. For example, -EU,NA excludes results from EU, but includes results from NA.

DateEnd param.Field[[]Time]Optional

End of the date range (inclusive).

DateRange param.Field[[]string]Optional

Filters results by date range. For example, use 7d and 7dcontrol to compare this week with the previous week. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

DateStart param.Field[[]Time]Optional

Start of the date range.

Format param.Field[NetFlowsTopAsesParamsFormat]Optional

Format in which results will be returned.

const NetFlowsTopAsesParamsFormatJson NetFlowsTopAsesParamsFormat = "JSON"

const NetFlowsTopAsesParamsFormatCsv NetFlowsTopAsesParamsFormat = "CSV"

GeoID param.Field[[]string]Optional

Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with - to exclude geoIds from results. For example, -2267056,360689 excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).

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 a comma-separated list of alpha-2 codes. Prefix with - to exclude locations from results. For example, -US,PT excludes results from the US, but includes results from PT.

Name param.Field[[]string]Optional

Array of names used to label the series in the response.

ReturnsExpand Collapse

type NetFlowsTopAsesResponse struct{…}

Meta NetFlowsTopAsesResponseMeta

Metadata for the results.

ConfidenceInfo NetFlowsTopAsesResponseMetaConfidenceInfo

Annotations []NetFlowsTopAsesResponseMetaConfidenceInfoAnnotation

DataSource NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceAll NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceAIBots NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceBGP NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceBots NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceCT NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceDNS NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceDos NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceFw NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceFwPg NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceHTTP NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceIQI NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceNet NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceSpeed NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventTypeEvent NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventTypeGeneral NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventTypeOutage NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventTypePipeline NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly NetFlowsTopAsesResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"

IsInstantaneous bool

Whether event is a single point in time or a time range.

LinkedURL string

formaturi

StartDate Time

formatdate-time

Tags []stringOptional

Level int64

Provides an indication of how much confidence Cloudflare has in the data.

DateRange []NetFlowsTopAsesResponseMetaDateRange

EndTime Time

Adjusted end of date range.

formatdate-time

StartTime Time

Adjusted start of date range.

formatdate-time

LastUpdated Time

Timestamp of the last dataset update.

formatdate-time

Normalization NetFlowsTopAsesResponseMetaNormalization

Normalization method applied to the results. Refer to Normalization methods.

One of the following:

const NetFlowsTopAsesResponseMetaNormalizationPercentage NetFlowsTopAsesResponseMetaNormalization = "PERCENTAGE"

const NetFlowsTopAsesResponseMetaNormalizationMin0Max NetFlowsTopAsesResponseMetaNormalization = "MIN0_MAX"

const NetFlowsTopAsesResponseMetaNormalizationMinMax NetFlowsTopAsesResponseMetaNormalization = "MIN_MAX"

const NetFlowsTopAsesResponseMetaNormalizationRawValues NetFlowsTopAsesResponseMetaNormalization = "RAW_VALUES"

const NetFlowsTopAsesResponseMetaNormalizationPercentageChange NetFlowsTopAsesResponseMetaNormalization = "PERCENTAGE_CHANGE"

const NetFlowsTopAsesResponseMetaNormalizationRollingAverage NetFlowsTopAsesResponseMetaNormalization = "ROLLING_AVERAGE"

const NetFlowsTopAsesResponseMetaNormalizationOverlappedPercentage NetFlowsTopAsesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const NetFlowsTopAsesResponseMetaNormalizationRatio NetFlowsTopAsesResponseMetaNormalization = "RATIO"

Units []NetFlowsTopAsesResponseMetaUnit

Measurement units for the results.

Name string

Value string

Top0 []NetFlowsTopAsesResponseTop0

ClientASN float64

ClientAsName string

Value string

A numeric string.

Get top ASes by network traffic

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Radar.NetFlows.Top.Ases(context.TODO(), radar.NetFlowsTopAsesParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "top_0": [
      {
        "clientASN": 16509,
        "clientASName": "AMAZON-02",
        "value": "10"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z",
            "tags": [
              "BOT_CLASS"
            ]
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "top_0": [
      {
        "clientASN": 16509,
        "clientASName": "AMAZON-02",
        "value": "10"
      }
    ]
  },
  "success": true
}