Skip to main content
GET
/
site
/
internal
/
{customer_id}
Get Customer Sites (Internal)
curl --request GET \
  --url https://{appDomain}/site/internal/{customer_id} \
  --header 'X-Bearer-Token: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "address": "<string>",
    "has_pulse": true,
    "uptime": "2 days, 5 hours, 10 minutes",
    "architecture_name": "<string>",
    "hardware_hash": "<string>",
    "serial_number": "<string>",
    "software_version": "<string>",
    "software_id": "<string>",
    "identity": "<string>",
    "last_seen_from": "127.0.0.1",
    "model": "<string>",
    "board_name": "<string>",
    "routerboard": true,
    "last_seen": "5 minutes ago",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "scheduler_removal": "in 1 day"
  }
]

Authorizations

​
X-Bearer-Token
string
header
required

Static token for internal service-to-service communication. Required for /site/internal/* endpoints.

Path Parameters

​
customer_id
string<uuid>
required

The UUID of the Customer.

Response

List of sites for the customer.

​
id
string<uuid>
​
name
string
​
address
string | null
​
has_pulse
boolean
​
uptime
string | null

Human-readable uptime string (e.g., "2 days, 5 hours, 10 minutes"). Null if no recent heartbeat.

Example:

"2 days, 5 hours, 10 minutes"

​
architecture_name
string | null
​
hardware_hash
string | null
​
serial_number
string | null
​
software_version
string | null
​
software_id
string | null
​
identity
string | null
​
last_seen_from
string<ipv4> | null

The public IP address the last heartbeat was received from.

​
model
string | null
​
board_name
string | null
​
routerboard
boolean | null
​
last_seen
string | null

Human-readable time since last heartbeat (e.g., "5 minutes ago").

Example:

"5 minutes ago"

​
last_seen_at
string<date-time> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
deleted_at
string<date-time> | null
​
scheduler_removal
string | null

Human-readable time until the scheduler removal job runs (after soft delete).

Example:

"in 1 day"

⌘I