Skip to content

ethernet_interfaces

Overview

API to get reports for Ethernet Interfaces (bandwidth is in Kbps and data is in KB)

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP

Tags

  • ethernet_interfaces : Operations related to ethernet_interfaces

Paths

Get operation for ethernet_interfaces

GET /ethernet_interfaces

Description

Use this operation to get a report for Ethernet interfaces. The response payload also contains the meta_data block.

Responses

HTTP Code Description Schema
200 API Successfully executed ethernet_interfaces_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • ethernet_interfaces

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

bandwidth_received

Receive bandwidth

Type : number

bandwidth_transmitted

Transmit bandwidth

Type : number

data_coverage

The amount, in percent of the selected time period for which there is data

Type : number

errors

Errors

Type : integer

ethernet_interface_name

The name

Type : string

ethernet_interfaces_delete_success_schema

Name Schema
ethernet_interfaces
optional
ethernet_interfaces

ethernet_interfaces

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

ethernet_interfaces_post_success_schema

Name Schema
ethernet_interfaces
optional
ethernet_interfaces

ethernet_interfaces

Name Description Schema
message
optional
Example : "resource added succesfully" string

ethernet_interfaces_put_success_schema

Name Schema
ethernet_interfaces
optional
ethernet_interfaces

ethernet_interfaces

Name Description Schema
message
optional
Example : "resource modified succesfully" string

ethernet_interfaces_response_schema

Type : < ethernet_interfaces_response_schema > array

ethernet_interfaces_response_schema

Name Schema
bandwidth_received
optional
bandwidth_received
bandwidth_transmitted
optional
bandwidth_transmitted
data_coverage
optional
data_coverage
errors
optional
errors
ethernet_interface_name
optional
ethernet_interface_name
link_state
optional
link_state
packets_received
optional
packets_received
packets_transmitted
optional
packets_transmitted
region_name
optional
region_name
site_name
optional
site_name

link_state

The worst state observed during the time period

Type : string

packets_received

Packets received

Type : integer

packets_transmitted

Packets transmitted

Type : integer

region_name

The region name

Type : string

site_name

The site name

Type : string