Litmus API PortalAPI hub for industrial data

Full REST and GraphQL API reference for Litmus Edge, Litmus Edge Manager, and Litmus Unify, covering DeviceHub, DataHub, Digital Twins, Flows Manager, Analytics, Companies, Edge Lifecycle Management, and UNS. Built for both engineers and AI agents.

Browse API Docs AI agents

Ways to access

Pick the surface that fits how you work, from an interactive browser to agent-ready manifests.

Product API documentation

Readable reference pages for each product, plus workflow guides and changelogs. Skim in the browser or share a direct link.

Explore the APIs

Endpoints grouped by Litmus product and version, 2,004 in total.

Litmus Edge 4.0.x

871 endpoints

Dashboard DeviceHub Digital Twins DataHub Flows Manager Analytics Applications Integration OPC UA System View in API collection

Litmus Edge Manager 2.31.x

304 endpoints

Companies Edge Lifecycle Management Digital Twins / Asset Management Admin Console APIs Marketplace Catalog View in API collection

Litmus Unify

46 endpoints

Dashboard UNS MQTT Integrations Configuration View in API collection

How-to: API workflow chains

56 endpoints

Many UI actions trigger multiple API calls behind the scenes. Each workflow shows the trigger, the ordered steps, and what each call returns.

Browse all 56 examples in API collection

Changelogs

2 changelogs

What changed between documented versions: endpoint relocations, added and deprecated operations, and the move to GraphQL.

Litmus Edge 3.16.x to 4.0.x Litmus Edge Manager 2.26.x to 2.31.x LE changelog in API collection LEM changelog in API collection

Older versions

727 endpoints

View the full documentation in the complete API collection.

Frequently asked questions

What the Litmus API Portal covers, how the products differ, and how to authenticate.

What is the Litmus API Portal?

The Litmus API Portal is the single reference for the REST and GraphQL APIs behind Litmus Edge, Litmus Edge Manager, and Litmus Unify. It documents 2,004 endpoints spanning device connectivity, data processing, fleet operations, and the MQTT Unified Namespace, with request examples in cURL, Python, and JavaScript.

How are Litmus Edge and Litmus Edge Manager different?

Litmus Edge is an industrial edge data platform that runs on a gateway or server: it connects to PLCs and sensors, collects tags through drivers such as Modbus, EtherNet/IP, and Siemens S7, runs analytics and Node-RED flows, and exposes data over OPC UA and MQTT. Litmus Edge Manager provides centralized edge management above it, used to deploy applications, manage licenses and RBAC, back up and restore edges, and operate many devices across sites from one place.

What is Litmus Unify?

Litmus Unify is an MQTT-based Unified Namespace (UNS). Its API manages broker accounts and ACL rules, the namespace and topic hierarchy, node configuration, and integrations with systems like Kafka. Versions before 2.0.0 were named Litmus UNS.

How do the Litmus APIs authenticate?

Litmus Edge and Litmus Unify use OAuth2 bearer tokens, with the client-credentials grant for Edge and the password grant for Unify, while Litmus Edge Manager uses an X-AuthToken admin API token. Each endpoint states the authentication it expects.

Are the APIs REST or GraphQL?

Both. Most endpoints are REST, while newer Litmus Edge 4.0.x areas such as Analytics and Integrations use GraphQL. Every product page marks which style each endpoint uses.

Can AI agents use the Litmus APIs?

Yes. Alongside the human-readable docs, the portal publishes an LLM-friendly router tree at /agents.md, a Model Context Protocol (MCP) manifest for tool-calling agents, a reference for the standalone litmus-cli binary (the preferred method for agentic tasks) and the Python SDK, and a machine-readable llms.txt index, so an agent can fetch a single API spec in isolation.