API Reference
3 min
API Reference
Per-module endpoint inventory. Each page in this section lists the endpoints in one product module with a one-line purpose.
Endpoint schemas live on api.litmus.io. Each service page below summarises what's available; for the full request/response schema and a runnable example, click through to the interactive API collection.
Where the detailed schema lives
These pages give the section-level orientation - what's in this module, how the endpoints relate, what the auth / URL pattern is. Full per-endpoint request / response schema is served by the visual API portal:
Surface | Use for |
|---|---|
api.litmus.io | Per-endpoint request body, response shape, try-it-out, code samples in cURL / Python / Go / Node / Shell |
api.litmus.io/agents | Agent-readable endpoint catalog for LLMs and automation |
When you find an endpoint here by name, follow the section link to the corresponding page on api.litmus.io for the schema and to test the call.
How to use this section
- Looking for one endpoint by name or purpose? Use the per-module pages here, then jump to api.litmus.io.
- Building a multi-step flow (chain several endpoints together)? Go to Workflows instead.
- New to a product? Start with Products for the high-level map.
Layout
- Litmus Edge - 9 modules: Dashboard, DeviceHub, Digital Twins, DataHub, Flows Manager, Analytics, Applications, Integration, OPC UA, System
- Litmus Edge Manager - 3 modules: Companies, Edge Lifecycle, Digital Twins
- Litmus UNS - 5 modules, all GraphQL on /mqtt/gql: Dashboard, UNS, Security, MQTT, Integrations