Retrieve the network status of a node on the underlying network interface
Parameters
Name
Description
Required
interface_id
The unique ID of the network interface
Yes
node_id
The unique ID of the node
Yes
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"api_interface_network_statuses","type":"object","properties":{"node_id":{"description":"Node Id","type":"number"},"node_name":{"description":"Node name","type":"string"},"update_status":{"type":"string","enum":["CHANGES_APPLIED","CHANGES_PENDING","UNAVAILABLE"],"description":"update_status:\n * `CHANGES_APPLIED` - UPDATE_STATUS_CHANGES_APPLIED,\n * `CHANGES_PENDING` - UPDATE_STATUS_CHANGES_PENDING,\n * `UNAVAILABLE` - UPDATE_STATUS_UNAVAILABLE"},"interface_details":{"description":"interface_details","type":"object","properties":{"speed":{"description":"Network card speed in Mbps.","type":"number"},"bytes_sent":{"description":"Bytes sent over the interface.","type":"string"},"bytes_received":{"description":"Bytes received over the interface.","type":"string"},"cable_status":{"type":"string","enum":["CONNECTED","DISCONNECTED","UNKNOWN"],"description":"Whether network card is connected via cable.:\n * `CONNECTED` - NETWORK_CABLE_CONNECTED,\n * `DISCONNECTED` - NETWORK_CABLE_DISCONNECTED,\n * `UNKNOWN` - NETWORK_CABLE_UNKNOWN"},"interface_status":{"type":"string","enum":["UP","DOWN","MISSING","UNKNOWN","NOTPRESENT","LOWERLAYERDOWN","TESTING","DORMANT"],"description":"Status of interface connection.:\n * `DORMANT` - NETWORK_INTERFACE_DORMANT,\n * `DOWN` - NETWORK_INTERFACE_DOWN,\n * `LOWERLAYERDOWN` - NETWORK_INTERFACE_LOWER_LAYER_DOWN,\n * `MISSING` - NETWORK_INTERFACE_MISSING,\n * `NOTPRESENT` - NETWORK_INTERFACE_NOT_PRESENT,\n * `TESTING` - NETWORK_INTERFACE_TESTING,\n * `UNKNOWN` - NETWORK_INTERFACE_UNKNOWN,\n * `UP` - NETWORK_INTERFACE_UP"},"mac_address":{"description":"MAC address.","type":"string"},"timestamp":{"description":"UNIX epoch timestamp for when the network status was sampled.","type":"string"}}},"interface_status":{"description":"interface_status","type":"object","properties":{"interface_id":{"description":"Unique identifier for this interface configuration.","type":"number"},"name":{"description":"Name of the configured interface i.e. bond0.","type":"string"},"default_gateway":{"description":"IPv4 default gateway on which all traffic generated from nodes is sent out on this interface.","type":"string"},"default_gateway_ipv6":{"description":"IPv6 default gateway on which all traffic generated from nodes is sent out on this interface.","type":"string"},"bonding_mode":{"type":"string","enum":["ACTIVE_BACKUP","IEEE_8023AD"],"description":"Ethernet bonding mode (ACTIVE_BACKUP or IEEE_8023AD), if this interface is bonded.:\n * `ACTIVE_BACKUP` - BONDING_MODE_ACTIVE_BACKUP,\n * `IEEE_8023AD` - BONDING_MODE_IEEE_8023AD"},"mtu":{"description":"The maximum transfer unit in bytes","type":"number"}}},"network_statuses":{"type":"array","items":{"description":"network_statuses","type":"object","properties":{"name":{"description":"User-assigned network configuration name","type":"string"},"assigned_by":{"type":"string","enum":["DHCP","STATIC","LINK_LOCAL"],"description":"How to assign IP address, either DHCP, STATIC, or LINK_LOCAL:\n * `DHCP` - NETWORK_ASSIGNED_BY_DHCP,\n * `LINK_LOCAL` - NETWORK_ASSIGNED_BY_LINK_LOCAL,\n * `STATIC` - NETWORK_ASSIGNED_BY_STATIC"},"address":{"description":"The IPv4 or IPv6 address in 0.0.0.0 or :: format","type":"string"},"floating_addresses":{"type":"array","items":{"description":"Floating IPv4 or IPv6 addresses in 0.0.0.0 or :: format","type":"string"}},"dns_servers":{"type":"array","items":{"description":"The list of DNS servers","type":"string"}},"dns_search_domains":{"type":"array","items":{"description":"The list of DNS search domains","type":"string"}},"netmask":{"description":"The IPv4 or IPv6 netmask in 0.0.0.0 or :: format, or the IPv4 or IPv6 subnet CIDR","type":"string"},"mtu":{"description":"The maximum transfer unit in bytes","type":"number"},"vlan_id":{"description":"User-assigned vlan_id tag for network configuration.","type":"number"}}}},"aws_status":{"description":"AWS Network Status.","type":"object","properties":{"eni_id":{"description":"ID of the network interface.","type":"string"},"device_number":{"description":"Device number of the interface.","type":"number"},"private_ipv4_addresses":{"type":"array","items":{"description":"All private IP addresses associated with the interface.","type":"string"}},"subnet_id":{"description":"ID of the subnet for the interface.","type":"string"},"subnet_mask":{"description":"Subnet mask of the interface.","type":"string"},"vpc_id":{"description":"ID of the VPC for the interface.","type":"string"},"security_groups":{"type":"array","items":{"description":"Names of the security groups applied.","type":"string"}}}},"azure_status":{"description":"Azure Network Status.","type":"object","properties":{"private_ipv4_address":{"description":"Private IPv4 address of this instance.","type":"string"},"network":{"description":"Azure network containing this instance.","type":"string"},"subnet_mask":{"description":"Subnet mask of the instance's network.","type":"string"}}},"gcp_status":{"description":"GCP Network Status.","type":"object","properties":{"private_ipv4_address":{"description":"Private IPv4 address of this instance.","type":"string"},"ip_aliases":{"type":"array","items":{"description":"List of IP aliases associated with this instance.","type":"string"}},"network":{"description":"GCP network containing this instance.","type":"string"},"subnet_mask":{"description":"Subnet mask of the instance's network.","type":"string"}}}}}
