Getting Started
5 min
Overview
The Litmus APIs expose everything that powers the Litmus Edge UI, Litmus Edge Manager, and Litmus UNS. Anything you can do in the product UI can be done over the API.
Tip: Once you have auth working, you can run every endpoint interactively at Litmus API Portal without writing any code.
Where to find what
You want... | Go to |
|---|---|
Per-endpoint request / response schema, try-it-out, code samples | https://api.litmus.io |
Agent-readable endpoint catalog (LLMs, scripts) | https://api.litmus.io/agents |
Concepts, getting started, multi-step workflows (this site) | https://docs.litmus.io/api-docs |
These three surfaces are designed to be used together. This site is the navigation and concepts layer that tells you how the products fit together and which endpoint to reach for; the visual portal at api.litmus.io is where you get the schema and run calls.
What this site covers
- How to authenticate (OAuth2 client credentials)
- Base URLs and environment setup for each product
- Section-level orientation per product / module
- Multi-step workflows the UI runs behind a single button click (create-device-with-tags, browse-and-import, deploy-application, backup-restore, etc.)
Who this is for
- Integrators connecting Litmus Edge / Manager / UNS to external systems
- Customers automating fleet operations (provisioning, app deploy, backups, alerts)
- Solution engineers and partners building on top of Litmus
What you need
- A running Litmus Edge / LEM / UNS instance (cloud or on-prem)
- OAuth2 client credentials (Admin generates these from the product UI)
- An HTTP client - cURL, Postman, Python requests, or the Litmus Python SDK
Next steps
- Authentication - obtain a Bearer token
- Base URLs and environments - what hostnames/paths to call
- First API call - confirm everything works end to end