We're looking for beta testers.

API reference

Public share links

Read-only monitor links with allowlisted public fields.

Password-protected or public read-only links for monitor data. Share URLs use an unguessable token (psh_…), not monitor ids. Responses expose an allowlisted field set only (name, description, location, status, open Starlink alert names, throughput, latency, obstruction, history charts).

Trip report sharing (#354) is planned to reuse the same token and access-mode pattern with a different resource_kind; only monitors is implemented today.

Management (session)

Organization owners and admins only.

MethodPathDescription
GET/v1/organizations/:org_id/public-sharesList active shares
POST/v1/organizations/:org_id/public-sharesCreate share
GET/v1/organizations/:org_id/public-shares/:share_idShare details
PATCH/v1/organizations/:org_id/public-shares/:share_idUpdate name, access, scope, monitors
DELETE/v1/organizations/:org_id/public-shares/:share_idRevoke share

Create body:

{
  "name": "Client view",
  "access_mode": "public",
  "scope_mode": "live_all",
  "password": "optional-when-access_mode-is-password",
  "monitor_ids": ["mon_…"]
}

scope_mode: live_all (all org monitors, including future) or selected (fixed set, editable).

Public (no session)

All public routes send X-Robots-Tag: noindex, nofollow, noarchive, Referrer-Policy: no-referrer, and are disallowed in the dashboard robots.txt under /share/.

MethodPathDescription
GET/v1/public/shares/:tokenShare metadata
POST/v1/public/shares/:token/unlockPassword gate (sets HttpOnly cookie)
GET/v1/public/shares/:token/itemsAllowlisted monitor list
GET/v1/public/shares/:token/items/:item_keyAllowlisted monitor detail
GET/v1/public/shares/:token/items/:item_key/metrics?timeframe=24hAllowlisted metrics series

Revoked shares return 410 with share_revoked.

Items include item_key, name, description, status, optional degraded_reason, location, open_alerts, and optional latest throughput/latency/obstruction snapshots (allowlisted fields only). degraded_reason is one of alerts, poor_link_quality, or telemetry_gaps and is omitted unless the item is degraded.