API Docs — Controller
Interactive OpenAPI documentation for each Aida Controller appliance (on-site).
Where to open it
On the controller (LAN address or remote tunnel):
| Entry | Path |
|---|---|
| Swagger UI | https://{controller-host}/docs |
| ReDoc (if enabled) | https://{controller-host}/redoc |
| OpenAPI JSON | https://{controller-host}/openapi.json |
You can also open Docs from the controller sidebar when you are signed into the controller UI (local or via Platform Remote).
:::info Platform vs controller These docs describe the appliance APIs. Cloud Platform docs are separate — see API Docs — Platform. :::
What it covers
Typical OpenAPI tags include:
| Area | Typical paths | Use |
|---|---|---|
| Health | health checks | Monitoring |
| Public API | /aida/api/* | Legacy-compatible REST for integrators and scripts |
| Controller API | /api/v1/* | Full controller REST (facility, devices, modules, system) |
| BACnet helpers | /api/v1/bacnet/* | When the BACnet/IP Server module is in use |
Schemas on the appliance are authoritative for that software version.
Authentication in the docs UI
Protected routes accept:
- JWT Bearer — from controller login
X-API-Key— static keys from API Keys — Controller
Use Authorize in Swagger, or send the same header your client will use. Do not send both Bearer and X-API-Key on one request.