Skip to content
Yagra

get_node_flow_top_as

GET
/api/v1/nodes/{node_id}/flow/top-as
curl --request GET \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/flow/top-as \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
node_id
required
string format: uuid

Exporter node id

Query Parameters

Section titled “Query Parameters”
from
integer format: int64
to
integer format: int64
limit
integer format: int32
proto
string
port
string
peer
string
asn
string
dir
string

Responses

Section titled “Responses”

200

Section titled “200”

Autonomous systems ranked by traffic, names resolved

Media typeapplication/json
Array<object>

An autonomous-system aggregate. asn = 0 means unknown (the UI labels it accordingly). name is resolved from the IP→ASN table at the API layer (the store leaves it None).

object
asn
required

Autonomous-system number (0 = unknown).

integer format: int32
bytes
required

Bytes.

integer format: int64
flows
required

Distinct flows.

integer format: int64
name

AS organization name, if resolvable.

string | null
packets
required

Packets.

integer format: int64
Examplegenerated
[
  {
    "asn": 1,
    "bytes": 1,
    "flows": 1,
    "name": "example",
    "packets": 1
  }
]

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks the read permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Section titled “503”

Flow monitoring is not enabled (no flow store configured)

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}