Traffic

Device traffic related API.

get

/Traffic/is-interf-pfc-enabled

Check if RoCE (RDMA over Converged Ethernet / PFC/) is enabled for a specific device interface.

Authorizations

authorizationstringRequired

Use User's Api for authorization

Query parameters

macstringRequired

Device MAC Address

Example: {"value":"3C:2C:99:EA:89:AB"}

ifnamestringRequired

Interface name of the device

Example: {"value":"Ethernet0"}

Responses

200

RoCE enablement status for the given interface

application/json

typestringOptionalExample: object

400

Bad Request - Missing or invalid parameters

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Traffic/is-interf-pfc-enabled

GET /api/Traffic/is-interf-pfc-enabled?mac=text&ifname=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

{
  "type": "object",
  "properties": {
    "roceEnabled": {
      "type": "boolean",
      "examples": null
    }
  }
}

get

/Traffic/trafficList

Fetch overall traffic list for landing page (topology view of devices and links).

Authorizations

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
"deviceAddress" : "all"
}

Note: Use "all" for all devices or specific device MAC/IP address.

Responses

200

List of devices and links with traffic stats (topology view)

No content

400

Bad Request - Invalid filter

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Traffic/trafficList

GET /api/Traffic/trafficList?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

/Traffic/getInterfaceDetails

Fetch aggregated interface details list for landing page (overview of interfaces and their traffic utilization, errors, status).

Authorizations

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
"deviceAddress" : "68:21:5F:A6:61:72",
"hostname" : "sonic",
"ipaddress" : "10.4.4.23",
"layer" : "Spine",
"timeBucket" : "60 minutes",
"windowSize" : "1 hour",
"license" : true
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

Aggregated list of interface details with utilization and error stats

No content

400

Bad Request - Invalid parameters

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Traffic/getInterfaceDetails

GET /api/Traffic/getInterfaceDetails?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

/Traffic/interfaceDetails

Fetch time-series interface details (errors, discards, PPS, utilization) for a specific device and interface.

Authorizations

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
"fromDate" : "2026-01-23 01:42:44",
"toDate" : "2026-01-23 02:42:44",
"windowSize" : "1 hour",
"deviceAddress" : "68:21:5F:A6:61:72",
"activeTab" : "basic",
"ifname" : "Ethernet0"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

Detailed interface traffic stats (time-series with PPS, errors, discards, utilization)

No content

400

Bad Request - Invalid filter

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Traffic/interfaceDetails

GET /api/Traffic/interfaceDetails?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

/Traffic/trafficMega

Aggregated traffic metrics for a given device/interface. Returns combined response of interface rate, stats, frames, unicast queues, and RoCE counters (if applicable).

Authorizations

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringOptional

{
"fromDate" : "2026-01-23 01:42:44",
"toDate" : "2026-01-23 02:42:44",
"windowSize" : "1 hour",
"deviceAddress" : "68:21:5F:A6:61:72",
"activeTab" : "basic",
"ifname" : "Ethernet0"
}

Note:
1. "deviceAddress" accepts IP or Mac address.
2. "ifname" is port identifier.
3. Includes RoCE data only if device supports RoCE.

Responses

200

Aggregated traffic response containing multiple sections.

application/json

typestringOptionalExample: object

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Traffic/trafficMega

GET /api/Traffic/trafficMega HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

{
  "type": "object",
  "properties": {
    "getInputOutputPackets": {
      "type": "array",
      "examples": null
    },
    "util": {
      "type": "array",
      "examples": null
    },
    "inputOutputErrors": {
      "type": "array",
      "examples": null
    },
    "inputOutputDiscards": {
      "type": "array",
      "examples": null
    },
    "bumPackets_in": {
      "type": "array"
    },
    "bumPackets_out": {
      "type": "array"
    },
    "unicastQueuePackates": {
      "type": "array"
    },
    "unicastQueueDrops": {
      "type": "array"
    },
    "RoceInputOutputPackets": {
      "type": "array"
    },
    "RoceDropCounters": {
      "type": "array"
    },
    "RoceCounterRate": {
      "type": "array"
    }
  }
}

get

/Traffic/priorityMapping

Get RoCE priority mapping configuration for a specific device interface including DSCP, DOT1P, WRED, Scheduler, PFC settings

Authorizations

authorizationstringRequired

Use User's Api for authorization

Query parameters

macAddressstringRequired

Device MAC address. Example: 04:3F:72:40:98:00

Example: {"value":"04:3F:72:40:98:00"}

ifnamestringRequired

Interface name. Example: Ethernet0

Example: {"value":"Ethernet0"}

Responses

200

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/Traffic/priorityMapping

GET /api/Traffic/priorityMapping?macAddress=text&ifname=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

PreviousInventory NextProtocols

Last updated 2 days ago