network

GET /network/config/bonds

List LACP bonds

Retrieves all LACP bonds on the host with health classification

Status Codes:

• 200 OK – List of bonds with LACP state + metrics

• 500 Internal Server Error – Internal server error

Response JSON Object:

• bonds[].active_aggregator (integer)

• bonds[].admin_state (string)

• bonds[].carrier (boolean)

• bonds[].health (string) – healthy|degraded_no_partner|degraded_slave_down|down

• bonds[].ip_addresses[] (string)

• bonds[].lacp_rate (string) – “fast” | “slow”

• bonds[].mac_address (string)

• bonds[].mode (string) – “IEEE 802.3ad …”

• bonds[].mtu (integer)

• bonds[].name (string) – “bond0”

• bonds[].oper_state (string)

• bonds[].partner_mac (string) – switch-side; zero = not negotiated

• bonds[].slaves[].aggregator_id (integer)

• bonds[].slaves[].link_failures (integer)

• bonds[].slaves[].mii_status (string) – “up” | “down”

• bonds[].slaves[].name (string)

• bonds[].slaves[].speed_mbps (integer)

• bonds[].slaves_total (integer)

• bonds[].slaves_up (integer)

• bonds[].xmit_hash_policy (string) – “layer3+4” etc

• count (integer)

• metrics.degraded_no_partner (integer)

• metrics.degraded_slave_down (integer)

• metrics.down (integer)

• metrics.healthy (integer)

• metrics.total (integer)

GET /network/config/bonds/{name}

Get bond status

Retrieves detailed LACP + per-slave state for one bond

Parameters:

• name (string) – Bond name (e.g. bond0)

Status Codes:

• 200 OK – OK

• 404 Not Found – Bond not found

Response JSON Object:

• active_aggregator (integer)

• admin_state (string)

• carrier (boolean)

• health (string) – healthy|degraded_no_partner|degraded_slave_down|down

• index (integer)

• ip_addresses[] (string)

• lacp_rate (string) – “fast” | “slow”

• mac_address (string)

• mode (string) – “IEEE 802.3ad …”

• mtu (integer)

• name (string) – “bond0”

• oper_state (string)

• partner_mac (string) – switch-side; zero = not negotiated

• slaves[].aggregator_id (integer)

• slaves[].link_failures (integer)

• slaves[].mii_status (string) – “up” | “down”

• slaves[].name (string)

• slaves[].speed_mbps (integer)

• slaves_total (integer)

• slaves_up (integer)

• stats.collisions (integer)

• stats.multicast (integer)

• stats.rx_bytes (integer)

• stats.rx_compressed (integer)

• stats.rx_crc_errors (integer)

• stats.rx_dropped (integer)

• stats.rx_errors (integer)

• stats.rx_fifo_errors (integer)

• stats.rx_frame_errors (integer)

• stats.rx_length_errors (integer)

• stats.rx_missed_errors (integer)

• stats.rx_over_errors (integer)

• stats.rx_packets (integer)

• stats.tx_aborted_errors (integer)

• stats.tx_bytes (integer)

• stats.tx_carrier_errors (integer)

• stats.tx_compressed (integer)

• stats.tx_dropped (integer)

• stats.tx_errors (integer)

• stats.tx_fifo_errors (integer)

• stats.tx_heartbeat_errors (integer)

• stats.tx_packets (integer)

• stats.tx_window_errors (integer)

• xmit_hash_policy (string) – “layer3+4” etc

GET /network/config/bridges

List network bridges

Retrieves a list of all network bridges

Status Codes:

• 200 OK – List of network bridges

• 500 Internal Server Error – Internal server error

Response JSON Object:

• bridges[].admin_state (string)

• bridges[].carrier (boolean)

• bridges[].flags[] (string)

• bridges[].ip_addresses[] (string)

• bridges[].mac_address (string)

• bridges[].members[] (string)

• bridges[].mtu (integer)

• bridges[].name (string)

• bridges[].offloads (object)

• bridges[].oper_state (string)

• bridges[].tx_qlen (integer)

• count (integer)

• metrics.active_bridges (integer)

• metrics.admin_down_count (integer)

• metrics.highest_error_bridge (string)

• metrics.highest_error_bridge_errors (integer)

• metrics.highest_mtu (integer) – Highest MTU

• metrics.highest_mtu_owner (string)

• metrics.inactive_bridges (integer)

• metrics.most_members_bridge (string)

• metrics.most_members_count (integer)

• metrics.most_used_bridge (string)

• metrics.most_used_bytes (integer)

• metrics.oper_down_count (integer)

• metrics.total_bridges (integer)

• metrics.total_errors (integer) – Error tracking

• metrics.total_members (integer) – Members

• metrics.total_rx_bytes (integer) – Aggregate traffic

• metrics.total_tx_bytes (integer)

• metrics.worst_oper_state (string)

• metrics.worst_state_bridge (string) – Worst state

GET /network/config/bridges/{name}

Get bridge status

Retrieves the status of a specific network bridge

Parameters:

• name (string) – Bridge name

Status Codes:

• 200 OK – Bridge status successfully retrieved

• 404 Not Found – Bridge not found

• 500 Internal Server Error – Internal server error

Response JSON Object:

• admin_state (string)

• allmulticast (boolean)

• carrier (boolean)

• flags[] (string)

• index (integer)

• ip_addresses[] (string)

• mac_address (string)

• master (string)

• members[] (string)

• mtu (integer)

• name (string)

• oper_state (string)

• promiscuous (boolean)

• raw_flags (integer)

• stats.collisions (integer)

• stats.multicast (integer)

• stats.rx_bytes (integer)

• stats.rx_compressed (integer)

• stats.rx_crc_errors (integer)

• stats.rx_dropped (integer)

• stats.rx_errors (integer)

• stats.rx_fifo_errors (integer)

• stats.rx_frame_errors (integer)

• stats.rx_length_errors (integer)

• stats.rx_missed_errors (integer)

• stats.rx_over_errors (integer)

• stats.rx_packets (integer)

• stats.tx_aborted_errors (integer)

• stats.tx_bytes (integer)

• stats.tx_carrier_errors (integer)

• stats.tx_compressed (integer)

• stats.tx_dropped (integer)

• stats.tx_errors (integer)

• stats.tx_fifo_errors (integer)

• stats.tx_heartbeat_errors (integer)

• stats.tx_packets (integer)

• stats.tx_window_errors (integer)

• tx_queue_len (integer)

• type (string) – always “bridge”

GET /network/config/interfaces

List network interfaces

Retrieves a list of all network interfaces

Status Codes:

• 200 OK – List of network interfaces

• 500 Internal Server Error – Internal server error

Response JSON Object:

• count (integer)

• interfaces[].admin_state (string)

• interfaces[].allmulticast (boolean)

• interfaces[].carrier (boolean)

• interfaces[].current_speed (integer)

• interfaces[].flags[] (string)

• interfaces[].hardware.bus_info (string) – PCI/USB bus address (e.g., “0000:01:00.0”)

• interfaces[].hardware.device_type (string) – “physical”, “virtual”, “bridge”, “vlan”, etc.

• interfaces[].hardware.driver (string) – Kernel driver name (e.g., “e1000e”, “ixgbe”)

• interfaces[].hardware.driver_version (string) – Driver version

• interfaces[].hardware.firmware_version (string) – Firmware version

• interfaces[].hardware.is_sriov_pf (boolean) – true if SR-IOV physical function

• interfaces[].hardware.is_sriov_vf (boolean) – true if SR-IOV virtual function

• interfaces[].hardware.mac_vendor (string) – Human-readable vendor name derived from PCI vendor ID

• interfaces[].hardware.modalias (string) – Device modalias string

• interfaces[].hardware.pci_device (string) – PCI device ID

• interfaces[].hardware.pci_subsystem (string) – PCI subsystem ID

• interfaces[].hardware.pci_vendor (string) – PCI vendor ID (e.g., “8086” for Intel)

• interfaces[].ip_addresses[] (string)

• interfaces[].last_state_change_secs (integer) – State change tracking

• interfaces[].mac_address (string)

• interfaces[].master (string)

• interfaces[].max_speed (integer)

• interfaces[].mtu (integer)

• interfaces[].name (string)

• interfaces[].offloads (object)

• interfaces[].oper_state (string)

• interfaces[].overall_state (string) – Computed display fields

• interfaces[].promiscuous (boolean)

• interfaces[].raw_flags (integer)

• interfaces[].sdwan_type (string)

• interfaces[].throughput_rx_mbps (number) – Throughput — 1-minute rolling average computed by the interface poller

• interfaces[].throughput_tx_mbps (number)

• interfaces[].tx_queue_len (integer)

• interfaces[].type (string)

• metrics.active_nics (integer)

• metrics.admin_down_count (integer)

• metrics.highest_error_nic (string) – NIC with the most errors

• metrics.highest_error_nic_errors (integer)

• metrics.highest_mtu (integer) – Highest MTU

• metrics.highest_mtu_owner (string)

• metrics.inactive_nics (integer)

• metrics.most_used_bytes (integer)

• metrics.most_used_nic (string)

• metrics.oper_down_count (integer)

• metrics.top_talker_nic (string)

• metrics.total_errors (integer) – Error tracking

• metrics.total_nics (integer)

• metrics.total_rx_bytes (integer) – Aggregate traffic

• metrics.total_tx_bytes (integer)

• metrics.worst_oper_state (string)

• metrics.worst_state_nic (string) – Worst state — the NIC with the worst oper_state (down > lowerlayerdown > unknown > up)

GET /network/config/interfaces/{name}

Get network interface status

Retrieves the status of a specific network interface

Parameters:

• name (string) – Interface name

Status Codes:

• 200 OK – Interface status successfully retrieved

• 404 Not Found – Interface not found

• 500 Internal Server Error – Internal server error

Response JSON Object:

• admin_state (string)

• alias (string)

• allmulticast (boolean)

• alt_names[] (string)

• carrier (boolean)

• flags[] (string)

• index (integer)

• ip_addresses[] (string)

• mac_address (string)

• master (string)

• mtu (integer)

• name (string)

• oper_state (string)

• perm_hw_addr (string)

• promiscuous (boolean)

• raw_flags (integer)

• stats.collisions (integer)

• stats.multicast (integer)

• stats.rx_bytes (integer)

• stats.rx_compressed (integer)

• stats.rx_crc_errors (integer)

• stats.rx_dropped (integer)

• stats.rx_errors (integer)

• stats.rx_fifo_errors (integer)

• stats.rx_frame_errors (integer)

• stats.rx_length_errors (integer)

• stats.rx_missed_errors (integer)

• stats.rx_over_errors (integer)

• stats.rx_packets (integer)

• stats.tx_aborted_errors (integer)

• stats.tx_bytes (integer)

• stats.tx_carrier_errors (integer)

• stats.tx_compressed (integer)

• stats.tx_dropped (integer)

• stats.tx_errors (integer)

• stats.tx_fifo_errors (integer)

• stats.tx_heartbeat_errors (integer)

• stats.tx_packets (integer)

• stats.tx_window_errors (integer)

• tx_queue_len (integer)

• type (string)

GET /network/config/vlan-interfaces

List VLAN sub-interfaces

Retrieves all 802.1Q VLAN sub-interfaces on the host with health classification

Status Codes:

• 200 OK – List of VLAN sub-ifaces + metrics

• 500 Internal Server Error – Internal server error

Response JSON Object:

• count (integer)

• metrics.degraded_mtu_exceeds_parent (integer)

• metrics.degraded_no_carrier (integer)

• metrics.down (integer)

• metrics.healthy (integer)

• metrics.total (integer)

• vlan_interfaces[].admin_state (string)

• vlan_interfaces[].carrier (boolean)

• vlan_interfaces[].health (string) – healthy|degraded_no_carrier|degraded_mtu_exceeds_parent|down

• vlan_interfaces[].ip_addresses[] (string)

• vlan_interfaces[].mac_address (string)

• vlan_interfaces[].master_bridge (string) – “cloudbr1” if enslaved

• vlan_interfaces[].mtu (integer)

• vlan_interfaces[].name (string) – “bond0.2005”

• vlan_interfaces[].oper_state (string)

• vlan_interfaces[].parent (string) – “bond0” | “eth4”

• vlan_interfaces[].parent_mtu (integer)

• vlan_interfaces[].vlan_tag (integer) – 2005

GET /network/config/vlan-interfaces/{name}

Get VLAN sub-interface status

Retrieves detailed state for one VLAN sub-iface incl. parent + master bridge

Parameters:

• name (string) – VLAN iface name (e.g. bond0.2005)

Status Codes:

• 200 OK – OK

• 404 Not Found – VLAN interface not found

Response JSON Object:

• admin_state (string)

• carrier (boolean)

• health (string) – healthy|degraded_no_carrier|degraded_mtu_exceeds_parent|down

• index (integer)

• ip_addresses[] (string)

• mac_address (string)

• master_bridge (string) – “cloudbr1” if enslaved

• mtu (integer)

• name (string) – “bond0.2005”

• oper_state (string)

• parent (string) – “bond0” | “eth4”

• parent_mtu (integer)

• stats.collisions (integer)

• stats.multicast (integer)

• stats.rx_bytes (integer)

• stats.rx_compressed (integer)

• stats.rx_crc_errors (integer)

• stats.rx_dropped (integer)

• stats.rx_errors (integer)

• stats.rx_fifo_errors (integer)

• stats.rx_frame_errors (integer)

• stats.rx_length_errors (integer)

• stats.rx_missed_errors (integer)

• stats.rx_over_errors (integer)

• stats.rx_packets (integer)

• stats.tx_aborted_errors (integer)

• stats.tx_bytes (integer)

• stats.tx_carrier_errors (integer)

• stats.tx_compressed (integer)

• stats.tx_dropped (integer)

• stats.tx_errors (integer)

• stats.tx_fifo_errors (integer)

• stats.tx_heartbeat_errors (integer)

• stats.tx_packets (integer)

• stats.tx_window_errors (integer)

• vlan_tag (integer) – 2005