Skip to main content
GET
/
sites
/
{siteId}
Retrieve a Site
curl --request GET \
  --url https://api.altostrat.io/sites/{siteId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a",
  "pid": "site_2m3h5n7k9j8g7f6e5d4c3b2a1",
  "name": "Main Office Router",
  "address": "Sydney, New South Wales, Australia",
  "has_pulse": true,
  "uptime": "3 days, 14 hours, 5 minutes",
  "architecture_name": "arm",
  "hardware_hash": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "serial_number": "HFB098M0M2P",
  "software_version": "7.15.1",
  "software_id": "U0B1-15HF",
  "identity": "HQ-Router",
  "last_seen_from": "203.0.113.54",
  "model": "RB5009UG+S+",
  "board_name": "RB5009",
  "routerboard": true,
  "last_seen": "2 minutes ago",
  "last_seen_at": "2025-10-29T11:45:56Z",
  "created_at": "2025-10-20T08:30:00Z",
  "updated_at": "2025-10-29T11:47:50Z",
  "deleted_at": null,
  "scheduler_removal": "in 23 hours"
}

Authorizations

โ€‹
Authorization
string
header
required

Authenticate requests by providing a JSON Web Token (JWT) in the Authorization header. Example: Authorization: Bearer <YOUR_JWT>

Path Parameters

โ€‹
siteId
string<uuid>
required

The UUID of the site to retrieve.

Response

The requested site object.

Represents the digital twin of a physical MikroTik device.

โ€‹
id
string<uuid>

The unique identifier (UUID) for the site.

Example:

"9a9a3e6f-1b1a-4b1a-8c1a-1e1a1a1a1a1a"

โ€‹
pid
string

A time-sortable, prefixed unique identifier for the site, suitable for user-facing display.

Example:

"site_2m3h5n7k9j8g7f6e5d4c3b2a1"

โ€‹
name
string

A user-defined name for the site.

Example:

"Main Office Router"

โ€‹
address
string | null

The geolocated physical address of the site.

Example:

"Sydney, New South Wales, Australia"

โ€‹
has_pulse
boolean

Indicates if the site is currently online and sending heartbeats. true if online, false if offline.

Example:

true

โ€‹
uptime
string | null

A human-readable representation of the device's current uptime.

Example:

"3 days, 14 hours, 5 minutes"

โ€‹
architecture_name
string | null

The CPU architecture of the device hardware.

Example:

"arm"

โ€‹
hardware_hash
string | null

A unique hash generated from the device's hardware identifiers.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"

โ€‹
serial_number
string | null

The serial number of the MikroTik device.

Example:

"HFB098M0M2P"

โ€‹
software_version
string | null

The RouterOS software version running on the device.

Example:

"7.15.1"

โ€‹
software_id
string | null

The software ID provided by RouterOS.

Example:

"U0B1-15HF"

โ€‹
identity
string | null

The identity name configured on the MikroTik device itself.

Example:

"HQ-Router"

โ€‹
last_seen_from
string<ipv4> | null

The public IP address from which the last heartbeat was received.

Example:

"203.0.113.54"

โ€‹
model
string | null

The specific model of the MikroTik device.

Example:

"RB5009UG+S+"

โ€‹
board_name
string | null

The board name of the MikroTik device.

Example:

"RB5009"

โ€‹
routerboard
boolean | null

Indicates if the device is a genuine RouterBOARD product.

Example:

true

โ€‹
last_seen
string | null

A human-readable string indicating how long ago the last heartbeat was received.

Example:

"2 minutes ago"

โ€‹
last_seen_at
string<date-time> | null

The specific timestamp (ISO 8601) of the last heartbeat.

Example:

"2025-10-29T11:45:56Z"

โ€‹
created_at
string<date-time>

The timestamp (ISO 8601) when the site was created.

Example:

"2025-10-20T08:30:00Z"

โ€‹
updated_at
string<date-time>

The timestamp (ISO 8601) when the site was last updated.

Example:

"2025-10-29T11:47:50Z"

โ€‹
deleted_at
string<date-time> | null

The timestamp (ISO 8601) when the site was marked for deletion.

Example:

null

โ€‹
scheduler_removal
string | null

A human-readable string indicating when the device's bootstrap scheduler will be removed.

Example:

"in 23 hours"