Authorizations
Authenticate requests by providing a JSON Web Token (JWT) in the Authorization header. Example: Authorization: Bearer <YOUR_JWT>
Response
A list of sites.
The unique identifier (UUID) for the site.
"9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a"
A time-sortable, prefixed unique identifier for the site, suitable for user-facing display.
"site_2m3h5n7k9j8g7f6e5d4c3b2a1"
A user-defined name for the site.
"Main Office Router"
The geolocated physical address of the site.
"Sydney, New South Wales, Australia"
Indicates if the site is currently online and sending heartbeats. true if online, false if offline.
true
A human-readable representation of the device's current uptime.
"3 days, 14 hours, 5 minutes"
The CPU architecture of the device hardware.
"arm"
A unique hash generated from the device's hardware identifiers.
"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
The serial number of the MikroTik device.
"HFB098M0M2P"
The RouterOS software version running on the device.
"7.15.1"
The software ID provided by RouterOS.
"U0B1-15HF"
The identity name configured on the MikroTik device itself.
"HQ-Router"
The public IP address from which the last heartbeat was received.
"203.0.113.54"
The specific model of the MikroTik device.
"RB5009UG+S+"
The board name of the MikroTik device.
"RB5009"
Indicates if the device is a genuine RouterBOARD product.
true
A human-readable string indicating how long ago the last heartbeat was received.
"2 minutes ago"
The specific timestamp (ISO 8601) of the last heartbeat.
"2025-10-29T11:45:56Z"
The timestamp (ISO 8601) when the site was created.
"2025-10-20T08:30:00Z"
The timestamp (ISO 8601) when the site was last updated.
"2025-10-29T11:47:50Z"
The timestamp (ISO 8601) when the site was marked for deletion.
null
A human-readable string indicating when the device's bootstrap scheduler will be removed.
"in 23 hours"