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 bsn control api integration guide docid 7yk3i2x7twfjhoyuemv3a for more information the properties that are displayed will depend on the type of interface the interfaces entity contains the following required properties id string string required required the type of network interface (for example,"wireless wlan0" or "wired eth0") name string string required required a target network interface name (for example, "wlan0", "eth0", "usb0", or "ppp0") type string string required required the player interface type (one of "ethernet", "cellular", "wifi", "virtual", or "other") proto string string required required a configuration protocol or given network interface such as "static" or "dhcpv4" ssid string string required required the wireless network name, which is required if the interface is wlan these optional properties can also be used ip string\[] string\[] or or null null optional optional an array of the target ipv4 addresses (in cidr notation) to apply by the current network interface gateway string or null string or null optional optional an ipv4 address of the player dns string\[] string\[] optional optional an array of the device dns addresses ratelimitduringinitialdownloads int or null int or null optional optional the data rate limit for downloading content during initial downloads ratelimitinsidecontentdownloadwindow int or null int or null optional optional the data rate limit during content downloads ratelimitoutsidecontentdownloadwindow int or null int or null optional optional the data rate limitation when content is not being downloaded contentdownloadenabled bool bool optional optional if true, content data can be downloaded using this connection true is the default textfeedsdownloadenabled bool bool optional optional if true, text feeds data can be downloaded using this connection true is the default mediafeedsdownloadenabled bool bool optional optional if true, media feed data can be downloaded using this connection true is the default healthreportingenabled bool bool optional optional if true, uploading health reporting data is enabled using this connection true is the default logsuploadenabled bool bool optional optional if true, uploading log updates is enabled using this connection true is the default passphrase string string optional optional the wireless network password security object object optional optional if this is provided, the following fields are required authentication object object mode string string possible network modes are "shared", "open", "eap" or "other" the default is “shared” passphrase string string the encrypted password for the network, if any encryption object object mode string string the possible encryption modes are "none", "wep", "tkip", "ccmp", "tkip,ccmp" or "other" the default is “tkip,ccmp” wpasettings object object optional optional if this is provided, the following fields are required enablewpaenterpriseauthentication bool bool if true, authentication via 802 1x (for wired) or wpa enterprise authentication (for wireless) is enabled wpaenterprisevariant string string either wpaenterpriseeaptls or wpaenterprisepeap eapcertificatetype string string either wpaeaptlspkcs or wpaeaptlspemorder eapcertificatefile object object 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 string a passphrase to protect the client certificate this can default to null if it is not applicable eappemorderkeyfile object object 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 default to null if it is not applicable peapusername string string the peap username for authentication this can default to null if it is not applicable peappassphrase string string the peap password for authentication this can default to null if it is not applicable cacertificatefile object object an artifact object that has a name (which is a string) and an asset (which is a pem/der ca certificate file) this can default to null if it is not applicable