---
title: Interfaces Entity (v3)
slug: develop/interfaces-entity-v3
docTags: 
createdAt: 2025-03-11T07:03:28.938Z
---

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 [this page](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` <font color="#704ae0">string</font> <font color="#01a0af">required</font>: The type of network interface (for example,"wireless\_wlan0" or "wired\_eth0")
- `name` <font color="#704ae0">string</font> <font color="#01a0af">required</font>: A target network interface name (for example, "wlan0", "eth0", "usb0", or "ppp0")
- `type` <font color="#704ae0">string</font> <font color="#01a0af">required</font>: The player interface type (one of "Ethernet", "Cellular", "WiFi", "Virtual", or "Other")
- `proto` <font color="#704ae0">string</font> <font color="#01a0af">required</font>: A configuration protocol or given network interface such as "Static" or "DHCPv4"
- `ssid` <font color="#704ae0">string</font> <font color="#01a0af">required</font>: The wireless network name, which is required if the interface is WLAN.

These optional properties can also be used:

- `ip`  <font color="#704ae0">string[]</font> <font color="#704ae0">or </font><font color="#704ae0">null</font> <font color="#01a0af">optional</font>: An array of the target IPv4 addresses (in CIDR notation) to apply by the current network interface.
- `gateway` <font color="#704ae0">string or null</font> <font color="#01a0af">optional</font>: An IPv4 address of the player.
- `dns` <font color="#704ae0">string[]</font> <font color="#01a0af">optional</font>: An array of the device DNS addresses
- `rateLimitDuringInitialDownloads` <font color="#704ae0">int or null</font> <font color="#01a0af">optional</font>: The data rate limit for downloading content during initial downloads.
- `rateLimitInsideContentDownloadWindow`<font color="#704ae0"> int or null</font> <font color="#01a0af">optional</font>: The data rate limit during content downloads.
- `rateLimitOutsideContentDownloadWindow` <font color="#704ae0">int or null</font> <font color="#01a0af">optional</font>: The data rate limitation when content is not being downloaded.
- `contentDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">optional</font>: If true, content data can be downloaded using this connection. True is the default.
- `textFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">optional</font>: If true, text feeds data can be downloaded using this connection. True is the default.
- `mediaFeedsDownloadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">optional</font>: If true, media feed data can be downloaded using this connection. True is the default.
- `healthReportingEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">optional</font>: If true, uploading health reporting data is enabled using this connection. True is the default.
- `logsUploadEnabled` <font color="#704ae0">bool</font> <font color="#01a0af">optional</font>: If true, uploading log updates is enabled using this connection. True is the default.
- `passphrase` <font color="#704ae0">string</font> <font color="#01a0af">optional</font>: The wireless network password
- `security` <font color="#704ae0">object</font> <font color="#01a0af">optional</font>: If this is provided, the following fields are required:
- `authentication` <font color="#704ae0">object</font>:
  - `mode` <font color="#704ae0">string</font>: Possible network modes are "Shared", "Open", "EAP" or "Other". The default is “Shared”
  - `passphrase` <font color="#704ae0">string</font>: The encrypted password for the network, if any
- `encryption` <font color="#704ae0">object:</font>
  - `mode` <font color="#704ae0">string</font>: The possible encryption modes are "None", "WEP", "TKIP", "CCMP", "TKIP,CCMP" or "Other". The default is “TKIP,CCMP”.
- `wpaSettings` <font color="#704ae0">object</font> <font color="#01a0af">optional</font>: If this is provided, the following fields are required:
  - `enableWPAEnterpriseAuthentication` <font color="#704ae0">bool</font>: If true, authentication via 802.1x (for wired) or WPA Enterprise Authentication (for wireless) is enabled.
  - `wpaEnterpriseVariant` <font color="#704ae0">string</font>: Either WPAEnterpriseEapTls or WPAEnterprisePeap
  - `eapCertificateType` <font color="#704ae0">string</font>: Either WPAEapTlsPKCS or WPAEapTlsPEMorDER
  - `eapCertificateFile` <font color="#704ae0">object</font>: 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` <font color="#704ae0">string</font>: A passphrase to protect the client certificate. This can default to null if it is not applicable.
  - `eapPemOrDerKeyFile` <font color="#704ae0">object</font>: 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` <font color="#704ae0">string</font>: The PEAP username for authentication. This can default to null if it is not applicable.
  - `peapPassphrase` <font color="#704ae0">string</font>: The PEAP password for authentication. This can default to null if it is not applicable.
  - `caCertificateFile` <font color="#704ae0">object</font>: 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.