Traffic Logs

List flow logs

get

Authorizations

Query parameters

network_idstringOptional

Filter by network ID

fromstringOptional

Start time in RFC3339 format

tostringOptional

End time in RFC3339 format

src_typestringOptional

Source type filter

src_entity_idstringOptional

Source entity ID filter

dst_typestringOptional

Destination type filter

dst_entity_idstringOptional

Destination entity ID filter

protocolstringOptional

Protocol filter

node_idstringOptional

Node ID filter

usernamestringOptional

Username filter

pageintegerOptional

Page number

per_pageintegerOptional

Items per page (max 1000)

Responses

200

OK

application/json

bytes_recvintegerOptional

bytes_sentintegerOptional

directionstringOptional

dst_entity_idstringOptional

dst_entity_namestringOptional

dst_ipstringOptional

dst_portintegerOptional

dst_typestringOptional

end_tsstringOptional

flow_idstringOptional

host_idstringOptional

host_namestringOptional

icmp_codeintegerOptional

icmp_typeintegerOptional

network_idstringOptional

packets_recvintegerOptional

packets_sentintegerOptional

protocolintegerOptional

src_entity_idstringOptional

src_entity_namestringOptional

src_ipstringOptional

src_portintegerOptional

src_typestringOptional

start_tsstringOptional

statusintegerOptional

versionstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

get/api/v1/flows

GET /api/v1/flows HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "bytes_recv": 1,
    "bytes_sent": 1,
    "direction": "text",
    "dst_entity_id": "text",
    "dst_entity_name": "text",
    "dst_ip": "text",
    "dst_port": 1,
    "dst_type": "text",
    "end_ts": "text",
    "flow_id": "text",
    "host_id": "text",
    "host_name": "text",
    "icmp_code": 1,
    "icmp_type": 1,
    "network_id": "text",
    "packets_recv": 1,
    "packets_sent": 1,
    "protocol": 1,
    "src_entity_id": "text",
    "src_entity_name": "text",
    "src_ip": "text",
    "src_port": 1,
    "src_type": "text",
    "start_ts": "text",
    "status": 1,
    "version": "text"
  }
]