K

Routers

Introduction

The /api/routers endpoint retrieves a list of MikroTik routers that belong to the team associated with the bearer token. Each router object provides detailed information about the router, including its identity, software version, uptime, and last seen details.

The Router Object

PropertyTypeDescription
idstringThe id field is an autogenerated v4 UUID that uniquely identifies the router.
identitystringThe identity field is the RouterOS identity or hostname of the router.
serial_numberstringThe serial_number field contains the serial number of the router. For CHR instances, this is the software ID.
software_versionstringThe software_version field indicates the current RouterOS version running on the router.
software_idstringThe software_id field is an identifier for the specific software running on the router.
has_pulsebooleanThe has_pulse field indicates if the site is online or offline based on the check-in scheduler.
uptimestringThe uptime field provides the duration for which the router has been running without interruption.
last_seenstringThe last_seen field indicates the time elapsed since the router was last seen.
last_seen_fromstringThe last_seen_from field is the IP address observed during the most recent heartbeat from the router.
routerboardbooleanThe routerboard field indicates if the device is a RouterBOARD model. (false for CHRs)
modelstringThe model field specifies the model of the router.
board_namestringThe board_name field provides the board name of the router.
last_seen_atstringThe last_seen_at field is a timestamp of the last time the router was seen.
created_atstringThe created_at field is a timestamp of when the router was created.

Retrieve a List of Routers

GET /api/routers

Sample Response

{
  "status": "success",
  "data": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "identity": "OfficeRouter",
      "serial_number": "123456789ABC",
      "software_version": "7.12.1 (stable)",
      "software_id": "3PA1-9SLK",
      "has_pulse": true,
      "uptime": "4 weeks 1 day 3 hours",
      "last_seen": "5 seconds ago",
      "last_seen_from": "1.2.3.4",
      "routerboard": true,
      "model": "RB952Ui-5ac2nD",
      "board_name": "hAP ac lite",
      "last_seen_at": "2024-05-28 08:00:00",
      "created_at": "2024-04-01 10:00:00"
    }
  ]
}

Router Metadata

It is possible to retrieve router metadata using the following endpoint:

Endpoint

GET /api/routers/{router_id}/metadata

Sample Response

{
  "status": "success",
  "data": {
    "name": "ExampleRouter",
    "timezone": "Europe/Rome",
    "boardname": "RB951Ui-2HnD",
    "model": "RB951Ui-2HnD",
    "routerboard": true,
    "banner_img": "https://cdn.mkcld.io/190_main_1521014029.jpeg",
    "thumbnail_img": "https://cdn.mkcld.io/902_m.png",
    "slug": "RB951Ui-2HnD",
    "last_seen_from": "11.22.33.44",
    "lat": 41.9027,
    "lng": 12.4963,
    "tunnel_ip": "100.127.255.255"
  }
}

Important Note

Metadata is a freeform key/value store, so it is possible that the response may include or exclude some properties.

Metadata Object

PropertyTypeDescription
namestringThe name of the router.
timezonestringThe timezone of the router's location.
boardnamestringThe board name of the router.
modelstringThe model of the router.
routerboardbooleanIndicates if the device is a RouterBOARD model.
banner_imgstringURL to the banner image of the router.
thumbnail_imgstringURL to the thumbnail image of the router.
slugstringA slug OEM identifier for the router.
last_seen_fromstringThe IP address observed during the most recent heartbeat from the router.
latnumberThe latitude of the router's location.
lngnumberThe longitude of the router's location.
tunnel_ipstringThe IP address of the management tunnel.

Retrieve OEM Information

The /api/routers/{router_id}/oem endpoint allows you to obtain manufacturer data for a given router. This information is maintained by MikroCloud and periodically retrieved from MikroTik. Efforts are made to ensure the data is accurate and extensive, but it is possible that data for particular hardware may not exist.

Endpoint

GET /api/routers/{router_id}/oem

Sample Response

{
  "status": "success",
  "data": {
    "category": "Wireless for home and office",
    "slug": "RB951Ui-2HnD",
    "archived": false,
    "name": "RB951Ui-2HnD",
    "model": "RB951Ui-2HnD",
    "short_description": "2.4GHz AP with five Ethernet ports and PoE output...",
    "product_details": "<p>The RB951Ui-2HnD is a wireless SOHO AP with a new...</p>",
    "architecture": "MIPSBE",
    "cpu": "AR9344",
    "cpu_core_count": "1",
    "cpu_nominal_frequency": null,
    "switch_chip_model": null,
    "router_os_license": "4",
    "operating_system": "RouterOS",
    "ram": "128 MB",
    "storage_size": "128 MB",
    "storage_type": "NAND",
    "mtbf": "Approximately 100'000 hours at 25C",
    "tested_ambient_temperature": "-20C +60C",
    "price": "$59.95",
    "banner": "https://cdn.mkcld.io/190_main_1521014029.jpeg",
    "thumbnail": "https://cdn.mkcld.io/902_m.png"
    // Additional fields may be included
  }
}

Important Note

These fields are generated based on the router's specifications, so it is possible that some columns may be null. This API also includes data on port speeds, and test speeds, and can be useful for rightsizing.

OEM Information Object

PropertyTypeDescription
categorystringThe category of the router.
slugstringA slug identifier for the router.
archivedbooleanIndicates if the router model is archived
namestringThe name of the router.
modelstringThe model of the router.
short_descriptionstringA short description of the router.
product_detailsstringDetailed product information.
architecturestringThe architecture of the router.
cpustringThe CPU model of the router.
cpu_core_countstringThe number of CPU cores.
cpu_nominal_frequencystringThe nominal frequency of the CPU.
switch_chip_modelstringThe model of the switch chip.
router_os_licensestringThe RouterOS license level.
operating_systemstringThe operating system of the router.
ramstringThe amount of RAM in the router.
storage_sizestringThe storage size of the router.
storage_typestringThe type of storage used in the router.
mtbfstringThe Mean Time Between Failures (MTBF) of the router.
tested_ambient_temperaturestringThe tested ambient temperature range for the router.
pricestringThe price of the router. (RRP in USD)
bannerstringURL to the banner image of the router.
thumbnailstringURL to the thumbnail image of the router.

Was this page helpful?