v1/network_interfaces
Use the v1/network_interfaces API to browser network interfaces of devices. Not all devices create network interface objects in the system.
URI
https://<hostname>/ws/v1/network_interfaces
Formats
| HTTP method | Format | Description | Parameters |
|---|---|---|---|
| GET | /ws/v1/network_interfaces | Get a summary of the network interface web service. | |
| POST | /ws/v1/network_interfaces/inventory | Create a network interface | |
| GET | /ws/v1/network_interfaces/inventory | Get a list of network interface. | query, size, orderby, cursor |
| GET | /ws/v1/network_interfaces/bulk | Get a CSV list of network interface. | query, orderby, cursor, fields |
| GET, PUT, DELETE | /ws/v1/network_interfaces/inventory/{id} | Get, update, or delete the specified network interface. |
Parameters
| Name | Description |
|---|---|
| cursor | Cursor to get the next page of devices. Omit on initial call. |
| fields | Comma-separated list of fields to return for bulk API |
| orderby | Specify any field described in the query parameter syntax. Optionally add ‘asc’ or ‘desc’ to control the sort order. |
| query | Specify the query to evaluate. See v1 API Query Language. |
| size | Maximum number of items to return. The maximum and default is 1000. |
Network Interface Fields
The device may not report all fields. The fields are:
active
Was the network interface active on the last report.
customer_id
Identifier for the customer that owns the data.
device_id
System-generated identifier for the device.
imsi
The International Mobile Subscriber Identity (IMSI) is a unique 15 digit value.
interface_type
As reported by the device, one of unspecified, gsm, cdma, orbcomm, iridium, lte.
phone_number
The phone number of the sim card if one exists.
server_keyword
The server keyword is used by some devices to send SMS messages via the server.
server_phone
The server phone number is used on some devices to verify the server sending SMS messages or to send SMS messages via the server.
sim_id
The SIM card identifier (iccid).