Overview
Litmus API Portal
The Litmus API Portal is the central reference for all Litmus Edge, Litmus Edge Manager (LEM), and Litmus UNS APIs. Whether you're automating device provisioning, building custom integrations, querying live industrial data, or embedding Litmus capabilities into your own applications, this portal has everything you need to get started and go deep.
APIs are available as both REST and GraphQL endpoints. The portal covers authentication, base URLs, error handling, pagination, and deprecation policies, as well as full API reference documentation organized by product and service.
Looking for the interactive API?
This site is the narrative documentation. For the executable Postman collection of all 1,944 endpoints plus AI-agent surfaces, visit https://api.litmus.io.
- Interactive API collection - run any endpoint
- AI agent routes - LLM-optimised router tree
- MCP manifest - tool calls for AI agents
- Python SDK docs - scripting reference
- llms.txt - site index for LLMs
What's Covered
- Litmus Edge API: DeviceHub, Digital Twins, DataHub, Flows Manager, Analytics, OPC UA, Marketplace, System, and Workflows
- Litmus Edge Manager API: device provisioning, alerts, project management, and the LEM Bridge
- Litmus UNS API: account provisioning and Unified Namespace data access
- Authentication: OAuth2 tokens, API keys, and SSL certificate configuration
- GraphQL vs REST: guidance on when to use each interface
- Resumable Uploads: for large files such as ML models, backups, and CA certificates
- Integration Providers: connecting external systems via the Litmus Edge integration layer
Common API Workflows
The portal includes step-by-step walkthroughs for the most common automation tasks:
- Create a DeviceHub device with tags
- Deploy an edge application to a device
- Configure an OPC UA server
- Provision a new edge device via LEM
- Upload an AI/ML model to LEM
- Create a project alert with trigger and action
- Backup and restore a Litmus Edge instance
- Provision a UNS account
Getting Started
New to the Litmus API? Start here:
- Authentication: generate your OAuth2 token or API key
- Base URLs & Environments: find the right endpoint for your Litmus instance
- First API Call: make a test request in under five minutes
- SSL Certificates: configure certificate validation for self-hosted deployments
API Reference
The full API reference is organized by service module. Each section documents available endpoints, request parameters, response schemas, and example payloads. Browse by product — Litmus Edge, Edge Manager, or UNS — or navigate directly to a service area: DeviceHub, Digital Twins, DataHub, Flows Manager, Analytics, OPC UA, System, or Marketplace.