API : Network Devices List

Introduction

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

Request

URL	https://api.telecomx.dk/network/device
Method	GET
Access level	VIEWER MANAGER OWNER RESELLER if customer belongs to the reseller or a sub reseller. RESELLER_ADMIN ADMIN.
Query	customer	`[optional]` Id of the customer to list licenses for, defaults to user's own customer if not set.
	offset	`[optional]` Index of first item to return. Defaults to 0.
	limit	`[optional]` Number of items to return, max 500. Defaults to 100.
	full	`[optional]` True to return full item, false for condensed version.

Query examples

https://api.telecomx.dk/network/device
https://api.telecomx.dk/network/device?customer=1234567890ABCDEF12345678

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 - full=false
Property	Type	Description
_id	Id	Unique id of the device.
state	String	Which state the device is in: ACTIVE, PROVISIONING, DELETING.
name	String	Name of device
model	Id	Id of network device
modelType	String	Model type
modelBrand	String	Brand name
modelPicture	Id	Id of picture of the device model, on the image servers.
macAddress	String	MAC address
jobs	Number	Number of provisioning jobs currently in progress.
wifiEnabled	Boolean	True if wifi is enabled.
dhcpEnabled	Boolean	True if DHCP is enabled.
provisioned	Boolean	True if the device is provisioned.
lastComm	Date	Timestamp of the last time this device was communicated with, either directly or through a third-party service
online	Boolean	True if the device is online.

Network device - full=true
Property	Type	Description
_id	Id	Unique id of the device.
state	String	Which state the device is in: ACTIVE, PROVISIONING, DELETING.
name	String	Name of device
model	Id	Id of network device
modelType	String	Model type
modelBrand	String	Brand name
modelDescription	String	Description of model
modelPicture	Id	Id of picture of the device model, on the image servers.
customer	Id	Customer the device belongs to
macAddress	String	MAC address
serialNumber	String	Serial number
mvnoAccount	Id	MVNO account that it is linked to. Used when the router is uplinked through a SIM-card.
jobs	Number	Number of provisioning jobs currently in progress.
notes	String	Free text note field.
wifi	Object	WiFi settings - set to null if not used.
wifi.enabled	Boolean	True if wifi is enabled on 2.4GHz.
wifi.ssid	String	SSID of the 2.4GHz network.
wifi.password	String	Password of the 2.4GHz network.
wifi.enabled5G	Boolean	True if wifi is enabled on 5GHz.
wifi.ssid5G	String	SSID of the 5Hz network.
wifi.password5G	String	Password of the 5GHz network.
wifi.enabled6G	Boolean	True if wifi is enabled on 6GHz.
wifi.ssid6G	String	SSID of the 6GHz network.
wifi.password6G	String	Password of the 6GHz network.
wifi.bandsteering	Boolean	True to enable bandsteering (all bands have same SSID and clients will move freely between bands.
dhcp	Object	DHCP settings - set to null if not used.
dhcp.enable	Boolean	True to enable DHCP.
dhcp.ipPoolStart	String	First IP address to assign to DHCP clients.
dhcp.ipPoolEnd	String	Last IP address to assign to DHCP clients.
dhcp.leaseTime	Number	Number of minutes DHCP leases last.
dhcp.primaryDnsServer	String	IP address of DNS server clients shall use.
dhcp.reservedClients[]	Array	List of DHCP clients with reservations.
dhcp.reservedClients[].mac	String	MAC address of the client.
dhcp.reservedClients[].ip	String	IP address to assign to the client.
dhcp.reservedClients[].enable	String	True if reservation is active.
dhcp.reservedClients[].id	String	Optional id of the reservation, as assigned by the device.
status	Object	Status info (read only)
status.provisioned	Boolean	True if the device is provisioned.
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.lanIp	String	LAN IP address.
status.subnetMask	String	Subnet mask.
status.gateway	String	Default gateway IP address.
status.wanIp	String	WAN IP address.
status.publicIp	String	Public IP address (may differ from WAN).
status.upTime	Number	Number of seconds the device has been running.
status.dns	String	IP address of primary DNS server.
status.dns2	String	IP address of secondary DNS server.
status.ipv6	String	IPv6 address, if available.
status.ipv6Dns	String	IPv6 primary DNS server.
status.ipv6Dns2	String	Ipv6 secondary DNS server.
status.simStatus	String	SIM status (mobile router): 1 = ready, 2 = pin_verified, 3 = pin_lock, 4 = puk_lock, 5 = blocked, 6 = no_sim, 7 = unknown
status.networkType	String	Type of network connection (mobile router only): 1 = none, 2 = gsm, 4 = wcdma, 8 = lte, 16 = lte_plus, 32 = nr
status.signalStrength	Number	4G signal strength (mobile router only) - 0-100
status.ssSingnalStrength	Number	5G signal strength (mobile router only) - 0-100
status.uplinkRate	Number	Uplink speed in Kbps.
status.downlinkRate	Number	Downlink speed in Kbps.
status.connectionTime	Number	Number of seconds device has been connected to the mobile network (mobile router only).

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",
      "modelPicture": "1234567890ABCD1234567890",
      "name": "My Primary Router",
      "customer": ObjectId("2234567890ABCD1234567890"),
      "macAddress": "00:4A:57:21:D9:01",
      "serialNumber": "NXQ26699371",
      "mvnoAccount": ObjectId("3234567890ABCD1234567890"),
      "network": {
        "wifi": {
          "ssid": "SkyNet",
          "password": "1NT3RN3T!"
        }
      },
      "status": {
        "provisioned:" true,
        "externalId": "124566adhasgdabsd__1823787d"
        "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 Devices List

Introduction

Request

Query examples

Response

Example - normal

Errors