API Overview
The Mirox platform exposes a REST API so you can integrate plant data, automation, and reporting into your own systems and workflows. Everything the web interface does is built on the same public endpoints, so you can drive the platform programmatically.
Interactive Documentation
The complete API specification is generated live from the running platform and is available in two interactive views:
- Swagger UI at
/docs— an interactive reference with a built-in request builder for trying calls directly in the browser. - ReDoc at
/redoc— the same specification in a layout optimized for reading and navigation.
Both views let you explore every available endpoint, its parameters, request body, and response format. They are the authoritative, always-current reference for what the API can do.
How the API Is Organized
API endpoints are grouped by what they act on, and every path is versioned (for example /v1/...). Common areas include:
- Plants, portfolios, and components — read and manage your monitored sites and their structure.
- Metrics and data export — export any metric as a time series, as CSV or, with
format=json, as JSON, and define metrics of your own. - Events, tickets, and reports — retrieve machine-detected signals, human follow-up work, and generated reports.
- Organization, cooperations, and access — manage members, sharing, and integration tokens.
Access to every endpoint is governed by your role and permissions. A call only returns the plants and data you are entitled to see, so the API enforces the same access rules as the interface.
Not Everything Is Listed in /docs
A few route groups are intentionally hidden from the published specification, so they will not appear in /docs or /redoc even though they work:
- Administrative endpoints — platform-administration functions reserved for Mirox staff.
- Device-assignment routes (
/v1/device).
If you need to integrate against one of these, contact Mirox support for guidance.
Time-Series Data
For time-series data, use the Metric Export API. It exports every metric of the collection — plant, component, sensor, turbine and battery level, and the metrics of your organization — at steps from 1 minute to a year. A GET request answers CSV; format=json answers JSON.
Organization Metrics (MetricsQL)
The metrics you define under Metrics have their own route group, /v1/report/metric: list, read, create, update and delete a metric, POST /v1/report/metric/validate to check an expression, POST /v1/report/metric/preview to run it against one plant, and GET /v1/report/metric/building-blocks for the series and configured values an expression may read. These metrics feed the reports and the Metric Export alike. MiroxQL formulas are the calculated columns of the legacy export; their routes stay available.
Getting Started
To call the API you authenticate with an API token scoped to a permission group. See the API Tokens guide for how to create, scope, and rotate tokens, then use them to make requests.
Open in Mirox
Create and manage your tokens under Profile — open the profile menu (top right) ▸ Profile and use the API tokens section.
For runnable, end-to-end integration code, see the worked example External Report Generator.
Related Features
- API Tokens — create and manage the scoped tokens that authenticate your API calls
- Metric Export API — export any metric as a time series, as CSV or JSON
- Legacy Export API — the previous export links, plant information and events
- MiroxQL Formulas — the formula routes of the legacy export
- Permission System — how roles and permission groups govern API access