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 https //api litmus io/view/2s9y5r1rvg 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 try it live https //api litmus io