API : Network Device Model List

Introduction

This request will return the list of all network devices for a specific customer.

Request

URL	https://api.telecomx.dk/network/device/model
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN or ADMIN.
	Property	Type	Description
Query	offset	Number	Index of first item to return, default 0.
Query	limit	Number	Max number of items to return, default 100, max 500.

Query examples

https://api.telecomx.dk/network/device/model

Response

JSON object
Property	Type	Description
offset	Number	Index of the network device returned.
limit	Number	Number of network devices to return. Note that the actual number of items returned may be lower.
total	Number	Number of network devices that can be returned when offset and limit is not considered. This is to be used for paging through the data.
networkDevices	Array	List of network devices, see definition below.

Network device
Property	Type	Description
_id	ObjectId	Id
state	String	Which state the device is in. Allowed values are CREATING, ACTIVE, DELETING
name	String	Name of device
model	Id	Id of network device model
modelType	String	Model type
modelBrand	String	Brand name
modelDescription	String	Description of network device model
customer	ObjectId	Customer the device belongs to
macAddress	String	MAC address
serialNumber	String	Serial number
mvnoAccount	ObjectId	MVNO account that it is linked to. Used when the router is uplinked through a SIM-card.
Status (read-only)
status.lastComm	Date	Timestamp of the last time this device was communicated with, either directly or through a third-party service
status.online	Boolean	True if the device is online.
status.localIpAddress	String	Local IP address of the device.
status.publicIpAddress	String	Public IP address of the device.

Note that properties holding no value may be omitted from the object.

Example - normal

{
  "offset": 10,
  "limit": 20,
  "total": 123,
  "networkDevices":
  [
    {
      "id": ObjectId("1234567890ABCD1234567890"),
      "state": "ACTIVE",
      "model": "1234567890ABCD1234567890",
      "modelType": "ROUTER",,
      "modelBrand": "TP-Link",
      "modelDescription": "TP-Link NX220v",
      "name": "My Primary Router",
      "customer": ObjectId("2234567890ABCD1234567890"),
      "macAddress": "00:4A:57:21:D9:01",
      "serialNumber": "NXQ26699371",
      "mvnoAccount": ObjectId("3234567890ABCD1234567890"),
      "network": {
        "wireless": {
          "ssid": "SkyNet",
          "password": "1NT3RN3T!"
        }
      },
      "status": {
        "lastComm": "2025-04-15T10:32:01.082Z",
        "online": true,
        "localIpAddress": "192.168.1.1",
        "publicIpAddress": "70.60.49.129",
      }
    },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	customer	Not found
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Network Device Model List

Introduction

Request

Query examples

Response

Example - normal

Errors