Usage, plans and monitoring API

Lumin Shield ↗Open panel ↗

Reading plan limits and server activity.

Plans and usage

Method	Path	Access
GET	/v1/plans	Public plan catalogue.
GET	/v1/orgs/{org}/subscription	member; current organisation plan.
GET	/v1/orgs/{org}/usage	member; traffic usage.

Usage accepts from and to as YYYY-MM-DD, plus optional routeId. Without dates, the API selects the current UTC month. Do not hardcode prices and quotas in your integration.

curl --fail-with-body \
  "https://lumin.edu.pl/v1/orgs/$LUMIN_ORG_ID/usage?from=2026-09-01&to=2026-09-30" \
  -H "Authorization: Bearer $LUMIN_API_KEY"

Only traffic forwarded to the backend counts towards plan usage. Blocked connections and status pings are excluded.

Monitoring

GET /v1/orgs/{org}/routes/{id}/monitoring requires admin access. Fields include online, sources, freshSources, updatedAt, since, truncated, players, events, points and protocolNames.

online: null means no fresh data. Check updatedAt and freshSources rather than presenting old data as current. Poll no more often than once every 5 seconds.

False positives can be reported with POST /v1/orgs/{org}/routes/{id}/false-positives. Select a real event in the panel first. Reports are rate limited and deduplicated; do not automatically report every rejection.