API Portal FAQs
API Portal FAQs
Who can access the API Portal?
The API Portal is available to all customers on the Scale plan. Other plan tiers can request access through their account team.
What's the difference between docs.litmus.io/api-docs and api.litmus.io?
They're two complementary surfaces.
- docs.litmus.io/api-docs (this site) is the narrative documentation: concepts, getting-started, walkthroughs, error model, and per-service reference summaries. Best when you want to understand what an API does and how it fits.
- api.litmus.io is the executable Postman collection: 1,944 endpoints across Litmus Edge, Edge Manager, and Unify. Best when you want to run an endpoint, fork the collection into your own workspace, or generate request code in cURL, Python, or JavaScript.
api.litmus.io also exposes AI-agent surfaces, an MCP manifest, a Python SDK reference, and llms.txt, none of which live here.
Are deprecated APIs listed here?
The portal is an exhaustive list of APIs that are actively managed by the Litmus team. APIs not listed here are not supported and may be deprecated. See Deprecation Policy.
What can I customize about the portal?
- Code samples: use the language dropdown to switch between Python, cURL, Go, Node.js, Shell, HTTP, and others.
- Postman: use the export option to import the full collection into Postman.
- Theme: toggle between light and dark.
- Layout: single-column vs multi-column.
I see a blank screen or data fetch error - what do I do?
- Refresh the page.
- Try an incognito / private window (rules out a stale cache or extension).
- If the issue persists, contact [email protected] with the exact URL and a screenshot.
I'm getting SSL certificate errors - what do I do?
Litmus Edge ships with a self-signed certificate. Until you install your own CA, clients reject the connection. Quick fixes:
Tool | Flag |
|---|---|
cURL | -k or --insecure |
Python requests | verify=False |
Postman | Settings -> General -> "SSL certificate verification" off |
Example:
curl -k "https://<le-ip>/devicehub/version" -H "Authorization: Bearer $TOKEN"Do not use these workarounds in production. Instead, install a CA-signed certificate via Upload Custom CA Certificate, or trust the edge's self-signed cert on your client. See SSL Certificates.
Where do I get OAuth credentials?
Product | Where |
|---|---|
Litmus Edge | System -> Settings -> Users -> API Clients |
LEM | Admin Console -> API Tokens |
LUNS | Admin -> Users (use the configured Keycloak user) |
What's the difference between LE Integration and LUNS Integration?
- LE Integration (/cc/v2): routes per-tag data from a single edge out to 45 supported providers (cloud queues, TSDBs, RDBMS).
- LUNS Integration: bridges the entire UNS namespace to another MQTT-like broker.
Both can coexist - LE Integration would typically be the path data takes to LUNS, then LUNS Integration bridges further out.
How do I contact support?
Email [email protected] or open a ticket via the Litmus support portal.