Retrieve a Site

Retrieve a Site

curl --request GET \
  --url https://v1.api.altostrat.io/sites/{siteId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v1.api.altostrat.io/sites/{siteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://v1.api.altostrat.io/sites/{siteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://v1.api.altostrat.io/sites/{siteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://v1.api.altostrat.io/sites/{siteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

GET

sites

{siteId}

Retrieve a Site

curl --request GET \
  --url https://v1.api.altostrat.io/sites/{siteId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v1.api.altostrat.io/sites/{siteId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://v1.api.altostrat.io/sites/{siteId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://v1.api.altostrat.io/sites/{siteId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://v1.api.altostrat.io/sites/{siteId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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.

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"

⌘I

Getting Started

Platform & Identity

Device Management & Orchestration

Automation & AI

Network Services & Connectivity

Security & Threat Management

Monitoring & Analytics

Core Services & Utilities

Authorizations

Path Parameters

Response