We're looking for beta testers.

API reference

API overview

Authenticate and explore the Orbimon HTTP API.

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

AreaPurpose
OrganizationsOrganization, members, roles, service tokens, monitors list
MonitorsStarlink metrics at raw, hourly, daily, and year resolution
AlertsStarlink alert settings, profiles, and per-monitor overrides
Audit logList and export organization audit events
EdgeEdge 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>
TokenPrefixAccess
User tokenomb_user_…Org and monitor APIs allowed by your role (owner / admin / member) and token scopes
Service tokenomb_svc_…Org-scoped automation; scopes read and optional write (created by owners/admins)
Monitor tokenomb_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

MethodPathDescription
GET/v1/organizationsGet your organization
POST/v1/organizationsCreate organization (if you have none)
GET/v1/organizations/:org_idOrganization details
PATCH/v1/organizations/:org_idUpdate name / slug
DELETE/v1/organizations/:org_idDelete organization (owner)
GET/v1/organizations/:org_id/usersList members
GET/v1/organizations/:org_id/monitorsList monitors (metadata)
POST/v1/organizations/:org_id/membersAdd existing user
PATCH/v1/organizations/:org_id/members/:user_idChange role
DELETE/v1/organizations/:org_id/members/:user_idRemove member
GET/v1/organizations/:org_id/tokensList service tokens (owner/admin)
POST/v1/organizations/:org_id/tokensCreate service token (owner/admin)
DELETE/v1/organizations/:org_id/tokensRevoke service token (owner/admin)
GET/v1/organizations/:org_id/public-sharesList public share links (owner/admin)
POST/v1/organizations/:org_id/public-sharesCreate public share link (owner/admin)
PATCH/v1/organizations/:org_id/public-shares/:share_idUpdate share link (owner/admin)
DELETE/v1/organizations/:org_id/public-shares/:share_idRevoke share link (owner/admin)
GET/v1/public/shares/:token/itemsPublic allowlisted monitor list (share token)
GET/v1/organizations/:org_id/usageMonthly API usage (owner/admin)

Organization limits and what counts toward usage: Limits.

Monitors (metrics)

MethodPathResolutionTypical range
GET/v1/monitors/:monitor_id/metrics/raw~1 secondUp to 12 hours
GET/v1/monitors/:monitor_id/metrics/hourly1 hourUp to ~30 days
GET/v1/monitors/:monitor_id/metrics/daily1 dayWeeks to months
GET/v1/monitors/:monitor_id/metrics/year1 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

MethodPathDescription
GET/v1/organizations/:org_id/alertsOrganization alert settings
PUT/v1/organizations/:org_id/alertsUpdate organization alert settings
GET/v1/monitors/:monitor_id/alert-settingsPer-monitor effective settings

Full map: Alerts API.

Audit log

MethodPathDescription
GET/v1/organizations/:org_id/audit-eventsList audit events (owner/admin)
GET/v1/organizations/:org_id/audit-events/exportCSV export (owner/admin)

Edge

MethodPathDescription
GET/v1/edge/configSend interval for the monitor's organization (monitor token)
POST/v1/ingestIngest telemetry from the Edge (monitor token)
GET/v1/edge/imageDownload Edge OS image (session or user/service token)
GET/v1/edge/image/infoEdge image metadata
GET/v1/ota/latestOTA manifest (monitor token)
GET/v1/ota/package/:version/:filenameOTA package redirect (monitor token)

Full details: Organizations · Monitors · Public share links · Edge

User token (session)

MethodPathDescription
GET/v1/me/tokenUser API token metadata (dashboard session only)
POST/v1/me/tokenRotate 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"
}
StatuserrorMeaning
400invalid_requestBad parameters or invalid date range
401unauthorizedMissing or invalid token
403forbiddenToken not allowed for this resource
404not_foundOrganization or monitor does not exist
429rate_limitedToo many requests
502upstream_errorTemporary 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:

GroupWhat you get
LinkConnected state, download/upload throughput, latency, packet loss
ObstructionPercent obstructed, flags, duration/interval
Orientation / GPSAzimuth, elevation, tilt, GPS satellite count
PowerWatts when available
AlertsDish alert codes for that sample or time bucket

Field list and units: Monitors → Metric fields.