Public HTTP API for Orbimon — use it to list organization members and monitors, and to pull Starlink telemetry for your sites.
Base URL: https://api.orbimon.com
Version: /v1
These pages are the public API documentation for integrators. If we change a public endpoint, request/response field, auth rule, or error, this documentation is updated in the same release.
What you can do
| Area | Purpose |
|---|---|
| Organizations | Create/manage your org, members, roles, and list monitors |
| Monitors | Read Starlink metrics at raw, hourly, daily, and year resolution |
More resources (alerts, billing) will be added here over time.
Authentication
Every request needs:
Authorization: Bearer <api_token>
| Token | Prefix | Access |
|---|---|---|
| User token | omb_user_… | Org + monitor APIs allowed by your role (owner / admin / member) and token scopes |
| Service token | omb_svc_… | Org-scoped automation; scopes read and optional write (created by owners/admins) |
| Monitor token | omb_mon_… | Metrics and Edge ingest for that monitor only |
Create and rotate tokens in the Orbimon dashboard (API access).
User tokens are personal. Service and monitor tokens are not tied to a person — when a teammate leaves, rotate them only if your policy requires it.
Never send Tinybird (or other backend) credentials. You only use Orbimon API tokens; Orbimon queries metrics on your behalf.
Endpoint map
Organizations
| Method | Path | Description |
|---|---|---|
GET | /v1/organizations | Get your organization |
POST | /v1/organizations | Create organization (if you have none) |
GET | /v1/organizations/:org_id | Organization details |
PATCH | /v1/organizations/:org_id | Update name / slug |
DELETE | /v1/organizations/:org_id | Delete organization (owner) |
GET | /v1/organizations/:org_id/users | List members |
GET | /v1/organizations/:org_id/monitors | List monitors (metadata) |
POST | /v1/organizations/:org_id/members | Add existing user |
PATCH | /v1/organizations/:org_id/members/:user_id | Change role |
DELETE | /v1/organizations/:org_id/members/:user_id | Remove member |
Monitors (metrics)
| Method | Path | Resolution | Typical range |
|---|---|---|---|
GET | /v1/monitors/:monitor_id/metrics/raw | ~1 second | Up to 12 hours |
GET | /v1/monitors/:monitor_id/metrics/hourly | 1 hour | Up to ~30 days |
GET | /v1/monitors/:monitor_id/metrics/daily | 1 day | Weeks–months |
GET | /v1/monitors/:monitor_id/metrics/year | 1 day (year view) | Up to 365 days |
Metrics endpoints take start and end (ISO 8601). Aggregated endpoints also accept metric (avg | max | min | p95).
Edge (Orbimon OS)
| Method | Path | Description |
|---|---|---|
GET | /v1/edge/config | Send interval for the monitor's organization |
POST | /v1/ingest | Ingest telemetry from the Edge (monitor token) |
Full details: Organizations · Monitors · Edge
Response format
Success
{
"data": { }
}
Lists and time series use "data": [ ... ]. Metrics responses also include "meta".
Error
{
"error": "unauthorized",
"message": "Missing or invalid Authorization header"
}
| Status | error | Meaning |
|---|---|---|
400 | invalid_request | Bad parameters or invalid date range |
401 | unauthorized | Missing or invalid token |
403 | forbidden | Token not allowed for this resource |
404 | not_found | Organization or monitor does not exist |
429 | rate_limited | Too many requests |
502 | upstream_error | Temporary metrics backend issue |
Metrics overview
While a Starlink is connected, Orbimon records roughly one sample per second. The API exposes:
| Group | What you get |
|---|---|
| Link | Connected state, download/upload throughput, latency, packet loss |
| Obstruction | Percent obstructed, flags, duration/interval |
| Orientation / GPS | Azimuth, elevation, tilt, GPS satellite count |
| Power | Watts when available |
| Alerts | Dish alert codes for that sample or time bucket |
Field list and units: Monitors → Metric fields.