Public HTTP API for Orbimon: list organization members and monitors, read Starlink telemetry, configure alerts, and download the Edge image.
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 | Organization, members, roles, service tokens, monitors list |
| Monitors | Starlink metrics at raw, hourly, daily, and year resolution |
| Alerts | Starlink alert settings, profiles, and per-monitor overrides |
| Audit log | List and export organization audit events |
| Edge | Edge ingest, config, image download, and OTA |
Customer-oriented walkthroughs live in the Getting started guide. Term definitions are in Concepts.
Authentication
Every request needs:
Authorization: Bearer <api_token>
| Token | Prefix | Access |
|---|---|---|
| User token | omb_user_… | Org and 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 user tokens under Settings, then Account. Create service tokens on the Organization page.
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.
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 |
GET | /v1/organizations/:org_id/tokens | List service tokens (owner/admin) |
POST | /v1/organizations/:org_id/tokens | Create service token (owner/admin) |
DELETE | /v1/organizations/:org_id/tokens | Revoke service token (owner/admin) |
GET | /v1/organizations/:org_id/public-shares | List public share links (owner/admin) |
POST | /v1/organizations/:org_id/public-shares | Create public share link (owner/admin) |
PATCH | /v1/organizations/:org_id/public-shares/:share_id | Update share link (owner/admin) |
DELETE | /v1/organizations/:org_id/public-shares/:share_id | Revoke share link (owner/admin) |
GET | /v1/public/shares/:token/items | Public allowlisted monitor list (share token) |
GET | /v1/organizations/:org_id/usage | Monthly API usage (owner/admin) |
Organization limits and what counts toward usage: Limits.
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 to 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).
Alerts
| Method | Path | Description |
|---|---|---|
GET | /v1/organizations/:org_id/alerts | Organization alert settings |
PUT | /v1/organizations/:org_id/alerts | Update organization alert settings |
GET | /v1/monitors/:monitor_id/alert-settings | Per-monitor effective settings |
Full map: Alerts API.
Audit log
| Method | Path | Description |
|---|---|---|
GET | /v1/organizations/:org_id/audit-events | List audit events (owner/admin) |
GET | /v1/organizations/:org_id/audit-events/export | CSV export (owner/admin) |
Edge
| Method | Path | Description |
|---|---|---|
GET | /v1/edge/config | Send interval for the monitor's organization (monitor token) |
POST | /v1/ingest | Ingest telemetry from the Edge (monitor token) |
GET | /v1/edge/image | Download Edge OS image (session or user/service token) |
GET | /v1/edge/image/info | Edge image metadata |
GET | /v1/ota/latest | OTA manifest (monitor token) |
GET | /v1/ota/package/:version/:filename | OTA package redirect (monitor token) |
Full details: Organizations · Monitors · Public share links · Edge
User token (session)
| Method | Path | Description |
|---|---|---|
GET | /v1/me/token | User API token metadata (dashboard session only) |
POST | /v1/me/token | Rotate user API token (dashboard session only) |
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 |
Monitor read caching and usage freshness: Limits.
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.