Interfaces Entity (v3)

An array of information about any network interface.

The order of the interface objects indicates the priority (“metric“) of each interface.The first interface object in the array is the highest priority interface and traffic will be sent to that interface if there is an active connection. All other interfaces are considered secondary interfaces. See Control Cloud API Integration Guide#DetermineNetworkInterfacePriorities for more information.

The properties that are displayed will depend on the type of interface:

id string required: The type of network interface (for example,"wireless_wlan0" or "wired_eth0")

name string required: A target network interface name (for example, "wlan0", "eth0", "usb0", or "ppp0")

type string required: The player interface type (one of "Ethernet", "Cellular", "WiFi", "Virtual", or "Other")

proto string required: A configuration protocol or given network interface such as "Static" or "DHCPv4"

ip  string[] or null required: An array of the target IPv4 addresses (in CIDR notation) to apply by the current network interface.

gateway string or null required: An IPv4 address of the player.

dns string[] required: An array of the device DNS addresses

rateLimitDuringInitialDownloads int or null required: The data rate limit for downloading content during initial downloads.

rateLimitInsideContentDownloadWindow int or null required: The data rate limit during content downloads.

rateLimitOutsideContentDownloadWindow int or null required: The data rate limitation when content is not being downloaded.

contentDownloadEnabled bool required: If true, content data can be downloaded using this connection. True is the default.

textFeedsDownloadEnabled bool required: If true, text feeds data can be downloaded using this connection. True is the default.

mediaFeedsDownloadEnabled bool required: If true, media feed data can be downloaded using this connection. True is the default.

healthReportingEnabled bool required: If true, uploading health reporting data is enabled using this connection. True is the default.

logsUploadEnabled bool required: If true, uploading log updates is enabled using this connection. True is the default.

ssid string required: The wireless network name.

passphrase string required: The wireless network password

security object required:

authentication object required:

mode string required: The possible network modes are "Shared", "Open", "EAP" or "Other"

passphrase string required: The encrypted password for the network

encryption object required:

mode string required: The possible encryption modes are "None", "WEP", "TKIP", "CCMP", "TKIP,CCMP" or "Other"

wpaSettings object required:

enableWPAEnterpriseAuthentication bool required: If true, authentication via 802.1x (for wired) or WPA Enterprise Authentication (for wireless) is enabled.

wpaEnterpriseVariant string required: Either WPAEnterpriseEapTls or WPAEnterprisePeap

eapCertificateType string required: Either WPAEapTlsPKCS or WPAEapTlsPEMorDER

eapCertificateFile object required:  An artifact object that has a name (which is a string) and an asset (which is a certificate file). This can default to null if it is not applicable.

eapCertificatePassphrase string required: A passphrase to protect the client certificate. This can can default to null if it is not applicable.

eapPemOrDerKeyFile  object required: An artifact object that has a name (which is a string) and an asset (which is a PEM or DER encoded X.509 certificate file).  This can can default to null if it is not applicable.


peapUsername  string required: The PEAP username for authentication. This can can default to null if it is not applicable.

peapPassphrase string required: The PEAP password for authentication. This can can default to null if it is not applicable.

caCertificateFile  object required: An artifact object that has a name (which is a string) and an asset (which is a PEM/DER CA certificate file). This can can default to null if it is not applicable.