Build

Public API

A documented, key-scoped REST API over your Helios data. Pull devices into your dashboards, sync tickets with another system, or open tickets from your own tooling.

Get a key

In the app, go to Settings, then API. Create a key with a name and the scopes it needs. The full key (it starts with hel_) is shown once at creation; only a hash is stored, so copy it then. Revoking a key takes effect immediately.

Authentication

Send the key as a bearer token on every request:

curl https://app.heliosmip.com/api/v1/devices \
  -H "Authorization: Bearer hel_your_key_here"

Scopes

• read:clients : list and read clients
• read:devices : list and read devices and health
• read:tickets : list and read tickets with comments
• write:tickets : create tickets
• read:alerts : list open and historical alerts

A key only ever sees your own organisation's data. Endpoints return 403 when the key lacks the needed scope.

Endpoints

The interactive reference at app.heliosmip.com/api/v1/docs documents every endpoint with schemas and a try-it-out console. In short: GET /clients, GET /devices, GET /tickets, POST /tickets and GET /alerts, plus single-resource reads, all with filtering and offset pagination (limit up to 200).

Limits and errors

• Rate limit: 120 requests per minute per key. Beyond it you get 429 with a Retry-After header.
• Billing: a lapsed subscription returns 402, the same as the app.
• Errors are JSON with a detail field; validation errors return 422.