Skip to main content

API Reference

Use the Polaris API to access device status, telemetry, and connected clients across your entire network fleet.

Query terminals, gateways, and clients from Starlink, Omada, and Reyee deployments — all from a single authenticated endpoint.

Base URL

https://polaris.revlv.com/v1

Authentication

All requests require a Bearer token in the Authorization header:

curl https://polaris.revlv.com/v1/devices \
-H "Authorization: Bearer {token}" \

Generate a token from the Polaris dashboard under Settings → API Tokens.

Response format

Successful responses wrap results in a data key:

{
"data": [ ... ]
}

Errors return a consistent shape:

{
"type": "authentication_error",
"message": "Invalid or missing access token."
}

Timestamps

All timestamp fields in requests and responses are UTC, encoded as ISO 8601 (e.g. 2026-05-12T05:54:18.735587Z). Convert to your local timezone client-side.

Rate limiting

  • 200 requests / 30 seconds

    Sliding window applied per workspace.

  • Shared bucket

    All API tokens issued under the same workspace share one limit — adding more tokens does not increase your quota.

  • 429 Too Many Requests

    Returned when the limit is exceeded. Check the Retry-After header for how long to wait.

Caching

  • 5 minute cache

    Successful responses are cached for 5 minutes, keyed per workspace and request URL.

  • Tenant-scoped

    Cached bytes never leak across workspaces.

  • Cache-Control

    Cached responses include a Cache-Control header reflecting the remaining TTL.