Automate your ISP with the Mycellium Data API
The v1 REST API is rolling out endpoint by endpoint. The health probe is already live and answering — subscribers, invoices, payments and tickets are next.
One endpoint up: the health probe
Point your uptime monitor at it. The probe reports platform status, central database reachability and queue depth — and answers 503 the moment the database is unreachable, so your alerts mean something.
- Public. No token required — safe for external monitors and status pages.
- Honest. 200 when the platform is healthy, 503 when the central DB is down.
- Ops-grade. Queue depth included, so backlogs page you before subscribers do.
Token-based, tenant-scoped, rate-limited
The authentication model is settled — the remaining endpoints land behind it as they ship.
Sanctum tokens
Personal access tokens issued per user, sent as a Bearer header. Tokens are revocable and scoped — a leaked key dies in one click.
Rate limits
100 requests per minute anonymous, 1,000 per minute with a token — per IP, with clear 429 responses when you push past it.
Tenant isolation
Every request resolves to one tenant's database. A token for your ISP can never read another ISP's subscribers — by architecture, not by policy.
Coming next on the v1 surface: subscribers, invoices, payments and tickets, plus signed webhooks for the events your NOC cares about. Integrators on the pilot get the endpoint catalog first.
Building an integration? Talk to us first
Tell us what you're wiring up — billing sync, RADIUS callbacks, a custom captive portal — and we'll get you tokens and the endpoint catalog as v1 lands.