# Litmus API Collection - LLM Navigation Guide > **You are reading this at `https://api.litmus.io/agents.md`.** > > This document is the entry point for AI assistants. The human-readable API workspace lives at > [api.litmus.io](https://api.litmus.io) - useful for humans but not easily machine-traversable. > > **This document IS your complete resource.** It contains every endpoint path, auth pattern, > request schema, and workflow you need. **Do NOT fetch `https://api.litmus.io/collections.json`** > -- that file is ~10 MB / ~180,000 tokens and will exhaust your context window before you can > complete the user's task. Use the Category Maps (section 4) and Traversal Algorithm (section 3) > to navigate directly without loading the collection. --- ## STOP: Do Not Fetch collections.json **Before doing anything else, read this.** `https://api.litmus.io/collections.json` is a ~10 MB raw JSON file (~180,000 tokens). Fetching it in full will fill or exceed your context window and make it impossible to complete the user's task. **This agents.md document already contains everything you need.** Use the first option below that applies to your task: | Your task | What to do -- NOT fetching collections.json | | --------- | ------------------------------------------ | | Call a specific API | Find the endpoint in the [Category Maps](#4-category-maps-by-product) -> apply [auth](#5-authentication) -> call it directly | | Need a request body | Check [Common Workflows](#10-common-workflows-cross-endpoint) and the [Quick Keyword Lookup](#quick-keyword---location-lookup); GraphQL examples are inline in [section 7](#7-graphql-endpoint-pattern) | | Unsure which endpoint to use | Use the [Term Disambiguation](#9-term-disambiguation) section, then the Category Maps | | Need detail on one specific endpoint | Use the [Traversal Algorithm](#3-traversal-algorithm) to read **only that single node**, never the collection root | **If you are about to write code or make an HTTP request targeting the full collections.json: stop and use this document instead.** --- ## Before You Search the Web Web searches for Litmus-specific topics return incomplete, outdated, or hallucinated results. **Every Litmus question has an authoritative, fetchable source.** Check the table below before triggering a web search. | What you are trying to find | Fetch this instead | | --------------------------- | ------------------ | | How to call a specific Litmus API, endpoint path, request format | This document -- [Category Maps](#4-category-maps-by-product), [Keyword Lookup](#quick-keyword---location-lookup), [Common Workflows](#10-common-workflows-cross-endpoint) | | How auth works, which token to use, how to get a token | This document -- [Authentication](#5-authentication) | | What a Litmus term means (Browse, Driver, Template, Instance...) | This document -- [Term Disambiguation](#9-term-disambiguation) | | How to configure a Litmus product feature (UI or conceptual guide) | `https://docs.litmus.io` -- fetch the relevant page directly | | Whether a pre-built solution covers the user's use case | `https://docs.litmus.io/solutions` -- fetch and scan categories | | Which drivers / protocols LitmusEdge supports right now | Call `POST {{edgeUrl}}/devicehub/v2` -> `{ ListDrivers { DriverID Name } }` | | Current state of a live system (devices, tags, apps, status) | Call the API directly -- live state is never in docs or search results | | Available MCP tools and how to invoke them | `https://api.litmus.io/mcp-agents.md` | | Python SDK methods and usage | `https://api.litmus.io/sdk-agents.md` | | Running reproducible API tests against a live LE instance | Use the standalone `litmus-api-test-harness` project (shell scripts + browser UI, separate repo) | | Licensing, downloads, software versions | `https://portal.litmus.io` | **Only use web search** for information that is genuinely external to Litmus: third-party service documentation (Azure IoT Hub, AWS IoT Core, InfluxDB, Kafka, Grafana, etc.), generic programming language questions, or community resources. Do not web-search for Litmus API behaviour, endpoint names, authentication methods, or product features -- the sources above are faster and accurate. --- ## Litmus Developer Ecosystem Three complementary layers are available for programmatic access to Litmus products. Choose the highest layer that covers your task: | Layer | What it is | Best for | Agents guide | | ------------------ | ----------------------------------------------- | ------------------------------------------------------ | ------------------------------------- | | **MCP Server** | ready-made LLM tools via Model Context Protocol | LLM agents - no code required, tool-call directly | `https://api.litmus.io/mcp-agents.md` | | **Python SDK** | `litmussdk` Python package wrapping all APIs | Scripts and agents that need broader coverage than MCP | `https://api.litmus.io/sdk-agents.md` | | **API Collection** | Raw Postman Collection v2.1, 1,934 endpoints | Full control, any language, operations not in SDK/MCP | This document | **Decision rule**: Use MCP tools if the operation is available there. Fall back to SDK, then to raw API calls. - MCP server repo: `https://github.com/litmusautomation/litmus-mcp-server` - SDK repo: `https://github.com/litmusautomation/litmus-sdk-releases` - Human-readable docs: `https://docs.litmus.io` --- ## Litmus Central Portal - portal.litmus.io **Register at `https://portal.litmus.io`** - this is the single hub for everything Litmus. Whether you are a human user or an AI agent helping a user, the portal unlocks the full Litmus ecosystem beyond just the API. ### Why register - **Single sign-on** across all Litmus products and interfaces - **Free sandbox** - deploy a private Litmus Edge instance to experiment without touching production - **License management** - purchase, activate, and manage licenses in one place - **Downloads** - access every software release, update, and wheel file - **Litmus Academy** - training and certification resources - **Live support** - chat support and help center at `https://support.litmus.io` - **Quotations** - request site-based plan pricing ### Ready-to-deploy Solutions Solutions are pre-packaged combinations of apps, deployment templates, and configuration tools providing out-of-the-box industrial use cases. An LLM agent helping a user implement a use case should check here first before building from scratch. **Docs index**: `https://docs.litmus.io/solutions` - fetch this page to discover which solution fits the user's need. | Category | Solutions available | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | Productivity | Excel AddIns for device/tag/digital twin management; Production Record Database (maintenance tracking, downtime monitoring) | | Data integration | LE to InfluxDB v2; LE-Native to InfluxDB v2; REST API to InfluxDB historian; Litmus Edge to Confluent Kafka (SSL/TLS) | | Edge protocols | LE Sparkplug Edge Node (MQTT Sparkplug B with TLS) | | Manufacturing / CNC | Fanuc CNC generic templates; Haas CNC via MTConnect; Siemens S7 browse agent; Omron NJ tag CSV tools | | Monitoring & analytics | Prometheus + Grafana dashboards; Kafka monitoring with Lenses; Syslog server integration; ML classification (Jupyter notebooks) | | Enterprise integrations | Oracle Smart Operations for SCM; GE Fanuc OPC UA servers; Ignition platform; Azure Manufacturing Data Solutions (MDS) | | Utilities | Synthetic data simulators; video frame streamers; file browsers; edge failover; CVE advisory reports | **When a user describes a use case**, fetch `https://docs.litmus.io/solutions` and scan for a matching solution before writing custom API calls or SDK code - a solution may already solve it end-to-end. ### Marketplace (45+ apps) The Public Marketplace hosts 45+ pre-built edge applications deployable directly from the portal or via the Applications API. Organizations can also create a **Private Marketplace** for custom or proprietary applications. - Browse apps: `Applications -> Marketplace -> Get Marketplace Apps` (in API collection) - Deploy from API: `Applications -> Marketplace -> Launch a Catalog App` - Manage a private marketplace: `Applications -> Configure -> List Marketplace Catalogs` ### Device Templates Device templates let you create a device and all its tags in a single action - no need to call CreateDevice then CreateTag for each register individually. - Templates can be scoped to all companies, a specific company, or a single project - Managed in LEM Admin Console: `Admin Console APIs -> Edge Devices -> Edge Device Templates` - Solutions library includes ready-made templates (e.g. Fanuc CNC Generic Template) ### Solutions as an AI agent workflow When a user asks "how do I integrate with X" or "I want to monitor Y": ``` 1. Fetch https://docs.litmus.io/solutions -> scan categories for a matching solution 2. If found: fetch the solution's doc page -> follow its deployment steps 3. If not found: use the API/SDK/MCP layer to build the integration 4. Cross-reference https://docs.litmus.io for product-specific how-to guides ``` --- ## 1. What You Are Working With The collection is a **Postman Collection v2.1** JSON file covering three Litmus products across multiple versions. It is a single monolithic JSON (~10 MB, ~180,000 tokens). **Loading it entirely will fill or exceed your context window** -- you will lose the conversation history needed to complete the user's task. For the vast majority of tasks, you do not need to read the collection file at all: the endpoint paths, auth patterns, request schemas, and full workflows are documented in this file. If you need to inspect one specific endpoint, use the Traversal Algorithm (section 3) to access only that node. ### Top-level JSON shape ``` { "info": { "name": "LE, LEM, LUNS API Docs", "schema": "...v2.1.0..." }, "item": [ /* array of product/version sections */ ], "event": [ /* collection-level pre-request and test scripts - both empty, skip */ ] } ``` The root `item` array has exactly **6 elements**: | Index | Name | Product | Status | | ----- | -------------------------------------------- | ------------------------ | ----------- | | 0 | `LitmusEdge 4.0.x API Documentation` | LitmusEdge (LE) | **Current** | | 1 | `LitmusEdge 3.16.x API Documentation` | LitmusEdge (LE) | Previous | | 2 | `LitmusEdgeManager 2.31.x API Documentation` | LitmusEdge Manager (LEM) | **Current** | | 3 | `LitmusEdgeManager 2.26.x API Documentation` | LitmusEdge Manager (LEM) | Previous | | 4 | `Litmus UNS` | LitmusUNS (LUNS) | **Current** | | 5 | `How-To: API Workflow Chains` | All products | Reference | **Default to index 0 (LE 4.0.x) and index 2 (LEM 2.31.x) unless the user specifies a version.** For multi-step workflow chains, navigate to index 5 (`How-To: API Workflow Chains`) and read the matching sub-folder `description` -- it contains the full ordered step table for that workflow. ### Products Quick Reference #### LitmusEdge (LE) Edge computing platform deployed on industrial gateway hardware. - Collects data from industrial devices (OPC UA, Modbus, EtherNet/IP, etc.) - Processes and stores data locally (DataHub = InfluxDB-backed time series) - Runs containerized applications (Docker via Applications API) - Publishes data via MQTT, REST, or cloud integrations - Base URL variable: `{{edgeUrl}}` #### LitmusEdge Manager (LEM) Fleet management plane for multiple LE instances. - Manages companies, sites, and projects - Handles bulk deployment and software updates - Centralizes Digital Twin asset models - Admin operations on port 8446 (`{{LEM_adminURL}}`) - Base URL variables: `{{LEM_URL}}`, `{{LEM_adminURL}}` #### Litmus UNS (LUNS) Unified Namespace - MQTT-based data fabric for Industrial IoT. - Manages MQTT broker accounts, topics, and namespaces - OAuth2 password-grant auth (`uns_oauth_client_id`, `uns_oauth_username`, `uns_oauth_password`) - Base URL variable: `{{uns_url}}` --- ## 2. The Item Node Schema Every node in the `item` tree is one of two types. Check `request` first: ``` Item (folder): { "name": "string", "item": [ ...child items... ], // FOLDER - recurse into this "description": "optional string", "auth": { ... } // optional, inherited by children } Item (request): { "name": "string", "request": { ... }, // REQUEST - this is a leaf "response": [ ...examples... ] // optional saved examples } ``` **Rule**: If `item.request` exists -> it is a request leaf. If `item.item` exists -> it is a folder. A node can technically have both (folder with its own request), but this is rare in this collection. ### Request object shape ```json { "method": "GET | POST | PUT | DELETE | PATCH", "url": { "raw": "{{edgeUrl}}/path/to/resource", "host": ["{{edgeUrl}}"], "path": ["path", "to", "resource"], "query": [{ "key": "param", "value": "val", "disabled": false }], "variable": [{ "key": "id", "value": "" }] }, "header": [{ "key": "Content-Type", "value": "application/json" }], "body": { ... }, "auth": { ... }, "description": "optional markdown string" } ``` ### Body object shape There are two body styles used in this collection: **REST/JSON body** (`mode: "raw"`): ```json { "mode": "raw", "raw": "{\"key\": \"value\"}", "options": { "raw": { "language": "json" } } } ``` **GraphQL body** (`mode: "graphql"`): ```json { "mode": "graphql", "graphql": { "query": "{ ListDevices { ID Name Status } }", "variables": "{}" } } ``` Some GraphQL calls use `mode: "raw"` with a JSON string that contains a `query` key - treat these the same way. --- ## 3. Traversal Algorithm Use this algorithm to navigate to any endpoint without loading the entire collection: ``` function findEndpoint(productIndex, categoryPath, endpointName): root = collection.item[productIndex] // select product section node = root for folder in categoryPath: // drill down through named folders node = node.item.find(x => x.name == folder) return node.item.find(x => // find the named request x.request != null and x.name.toLowerCase().contains(endpointName.toLowerCase()) ) ``` **Example - find "Create New Device" in LE 4.0.x:** ``` LitmusEdge 4.0.x -> DeviceHub -> Devices -> Create New Device ``` Prefer name-based traversal. Index-based navigation is fragile - if the collection gains or reorders folders, all hardcoded indices break. Only use indices for the top-level product sections (0-4), which are stable. For reference, the index-based equivalent of the above is: ``` collection.item[0] // LitmusEdge 4.0.x .item[2] // DeviceHub (index 2 after OAuth guide + Dashboard) .item[0] // Devices (subfolder) .item[1] // "Create New Device" request ``` ### Response examples Each request may have a `response[]` array of saved examples. To see an example response: ``` request.response[0].code // HTTP status code (e.g., 200) request.response[0].status // "OK" request.response[0].body // JSON string of response body ``` --- ## 4. Category Maps by Product ### LitmusEdge 4.0.x - Categories (index 0) | Category | Subfolder depth | Endpoint style | Base path | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------------------------------- | | How to Use OAuth2 Authorization | 0 (description only) | - | - | | Dashboard | 1 | REST | multiple | | DeviceHub | 2 (Devices, Drivers, Tags, Browse, Asset Discovery, Prometheus, **Create Device - Driver Examples**, **Register Types - Driver Reference**) | **GraphQL** | `POST {{edgeUrl}}/devicehub/v2` | | Digital Twins | 2 (Models, Instances + sub-sub-folders) | **GraphQL** | `POST {{edgeUrl}}/digital-twins` | | DataHub | 1 (+ Prometheus sub) | REST | `{{edgeUrl}}/stats/...` | | Flows Manager | 1 | REST | `{{edgeUrl}}/flows-manager/...` | | Analytics | 2 (Instances, Models, Variables, Prometheus) | **GraphQL** | `POST {{edgeUrl}}/analytics/v3` | | Applications | 2 (Dashboard, Catalog Apps, Configure, Marketplace, Containers, Networks, Images, Registry, Volumes, System Info, Disk Usage, Prometheus) | REST | `{{edgeUrl}}/apps/...` | | Integration | 2 (Streaming, Object, Prometheus, **Create Instance - Provider Examples**, **Provider Schemas - Reference**) | **GraphQL** | `POST {{edgeUrl}}/cc/v2` | | OPC UA | 2 (Hierarchy, Management, Connections) | **GraphQL** | `POST {{edgeUrl}}/opcua/v2` | | System | 2 (Info, Activation, Device Management, Network, External Storage, Access Control, Events, Support) | REST (mixed) | `{{edgeUrl}}/dm/...` | ### LitmusEdge Manager 2.31.x - Categories (index 2) | Category | Subfolder depth | Base URL variable | | ------------------------------ | --------------- | ------------------------------ | | Companies | 1 | `{{LEM_URL}}` | | Edge Lifecycle Management | 2 | `{{LEM_URL}}` | | Digital Twins/Asset Management | 2 | `{{LEM_URL}}` | | Admin Console APIs | 2 | `{{LEM_adminURL}}` (port 8446) | ### Litmus UNS - Categories (index 4) | Category | Base URL variable | Notes | | ------------ | ----------------- | ----------------------------------- | | Dashboard | `{{uns_url}}` | | | UNS | `{{uns_url}}` | | | Security | `{{uns_url}}` | | | MQTT | `{{uns_url}}` | | | Integrations | `{{uns_url}}` | | | Tools | `{{uns_url}}` | Single endpoint: MQTT Server Config | ### How-To: API Workflow Chains - Categories (index 5) Description-only sub-folders documenting the multi-step API chains triggered by single UI actions. Each sub-folder contains no executable requests -- its value is the `description` field, which has the step table. Read the folder `description` to get the full chain for that workflow. | Sub-folder | Workflow it documents | | -------------------------------- | --------------------------------------------------------- | | Apply / Upload Template | DELETE -> POST -> PUT resumable upload to `/dm/template/v2` | | Restore Backup | DELETE -> POST -> PUT resumable upload to `/dm/backup/v2` | | Upload Custom CA Certificate | POST -> PUT to `/dm/certstore` | | Upload Analytics / AI Model | DELETE -> POST -> PUT to `/analytics/v2/upload_model/v2` | | Upload AI/ML Model (LEM) | POST (get S3 URL) -> PUT to S3 -> POST (register in LEM) | | Create Device + Tags | ListDrivers -> GetDriver -> CreateDevice -> CreateRegisters | | Browse - Bulk Tag Discovery | CreateBrowseTask -> Start -> Poll -> Cart -> CreateAllRegisters | | Create Integration Instance | GetProviderSchema -> CreateInstance -> ListInstances -> CreateSubscription | | Deploy Application | List Catalogs -> Get Apps -> Launch -> Verify running | | Configure OPC UA Server | GetNodeRoot -> ImportTags -> StartOPCUAService | --- ## 5. Authentication ### How auth works in this collection Auth can be set at three levels (most specific wins): 1. **Request level** - `request.auth` 2. **Folder level** - `folder.auth` (inherited by all children) 3. **Collection level** - `collection.auth` (global default) ### Auth type: `basic` (API Token) Grants full access to all LE endpoints -- REST and GraphQL alike. DeviceHub, Digital Twins, OPC UA, and every other LE GraphQL service all accept Basic auth with `{{apiToken}}`. Use this when you have a plain API token. ```json { "type": "basic", "basic": [{ "key": "username", "value": "{{apiToken}}", "type": "string" }] } ``` How to call: ```bash # REST endpoint: curl -H "Authorization: Basic BASE64(apiToken:)" https://{{edgeUrl}}/devicehub/version # GraphQL endpoint -- same Basic auth header, GraphQL body: curl -H "Authorization: Basic BASE64(apiToken:)" https://{{edgeUrl}}/devicehub/v2 \ -H "Content-Type: application/json" \ -d '{"query": "{ ListDevices { ID Name Status } }"}' ``` The trailing colon is intentional - the API token is used as the username with a blank password. `curl -u "token:"` sets username=token, password=(empty). ### Auth type: `oauth2` (Client Credentials) Grants granular, RBAC-scoped access to LE endpoints. Use this when you need to restrict which resources or operations a token can access. Works on the same endpoints as Basic auth -- the difference is access scope, not endpoint coverage. **Getting client credentials (human step, done once in the LE UI):** 1. Log in to Litmus Edge -> System -> Access Control -> Tokens 2. Click **Add API Credentials** 3. Select **OAuth Client Category** and assign RBAC groups 4. Set expiration, provide a token name, click **Create** 5. Copy the generated `clientID` and `clientSecret` -- they are shown only once Token URL in this collection: ``` POST {{edgeUrl}}/auth/v3/oauth/token Content-Type: application/x-www-form-urlencoded Authorization: Basic BASE64(client_id:client_secret) Body: grant_type=client_credentials ``` **Important**: The token URL is `/auth/v3/oauth/token` - **not** a Keycloak realm URL. This is Litmus Edge's own OAuth2 proxy endpoint. Token response: ```json { "access_token": "eyJ...", "token_type": "bearer", "expires_in": 3600 } ``` Use the token on any LE endpoint: ```bash curl -H "Authorization: Bearer ACCESS_TOKEN" https://{{edgeUrl}}/ ``` Token caching: Cache the token and refresh it 60 seconds before `expires_in` elapses, or on 401. ### Auth type: LEM `X-AuthToken` Used by all LEM endpoints at `{{LEM_URL}}` and `{{LEM_adminURL}}`. LEM does not use Basic or Bearer auth - it uses a custom HTTP header. ``` X-AuthToken: {{LEM_AdminApiToken}} ``` How to call: ```bash curl -H "X-AuthToken: YOUR_TOKEN" https://{{LEM_URL}}/api/v1/company/list ``` Tokens are created in the LEM Admin Console at `{{LEM_adminURL}}` (port 8446) under Settings -> Tokens. Each token has three attributes: - **Name** - identifier - **TTL** - expiration date - **Scope** - which companies/projects the token can access **Exception - Marketplace Catalog folder**: This folder uses `Authorization: {{LEM_AdminApiToken}}` instead of `X-AuthToken`. The collection notes this explicitly: "Please notice the difference in Authorization for Marketplace Catalog." ```bash # Marketplace Catalog endpoints only: curl -H "Authorization: YOUR_TOKEN" https://{{LEM_URL}}/api/v1/... ``` ### Auth type: LEM Bridge Token (proxy LE APIs through LEM) Available since LEM 2.15.0. A LEM token with the **Edge API Bridge** option enabled lets you call any Litmus Edge API through a single LEM endpoint -- no separate LE credential needed. This is useful when your agent only holds LEM credentials and needs to reach LE APIs on one or more managed devices. **Enable during token creation**: In LEM Admin Console -> Settings -> Tokens -> Add Token, check the **Edge API Bridge** checkbox at step 4 before saving. The token scope (company/project) must cover the target edge device. **URL pattern** -- replace the LE base URL and LE API path as follows: ``` # Normal LE call: https://{{edgeUrl}}/devicehub/version # Equivalent via LEM bridge: https://{{LEM_URL}}/api/v1/edge/{project-id}/{edge-device-id}/devicehub/version ``` The full bridge URL structure: ``` https://{{LEM_URL}}/api/v1/edge/{project-id}/{edge-device-id}/ ``` - `{project-id}` -- visible in the LEM UI address bar after the company name when you open a device - `{edge-device-id}` -- visible in the same address bar after `device/` **Auth header** -- same `X-AuthToken` header as all other LEM calls: ```bash curl -H "X-AuthToken: YOUR_BRIDGE_TOKEN" \ https://{{LEM_URL}}/api/v1/edge/{project-id}/{edge-device-id}/devicehub/version ``` GraphQL calls work identically -- post the GraphQL body to the bridge URL instead of the edge URL: ```bash curl -H "X-AuthToken: YOUR_BRIDGE_TOKEN" \ -H "Content-Type: application/json" \ -d '{"query": "{ ListDevices { ID Name Status } }"}' \ https://{{LEM_URL}}/api/v1/edge/{project-id}/{edge-device-id}/devicehub/v2 ``` **When to use bridge vs direct LE auth**: | Situation | Use | | --------- | --- | | Agent has LEM credentials only | LEM Bridge Token | | Agent needs to reach multiple LE devices via one auth token | LEM Bridge Token | | Agent talks directly to a single LE instance | Basic (`apiToken`) or OAuth2 | ### Auth type: UNS OAuth2 (Password Credentials) Used by all LUNS endpoints. Auth is set at the top level of the `Litmus UNS` collection section and inherited by all children. Token URL: ``` POST {{uns_url}}/auth/realms/standalone/protocol/openid-connect/token Content-Type: application/x-www-form-urlencoded grant_type=password &client_id={{uns_oauth_client_id}} &username={{uns_oauth_username}} &password={{uns_oauth_password}} &scope=openid ``` Token response: ```json { "access_token": "eyJ...", "token_type": "Bearer", "expires_in": 3600 } ``` Use the token: ```bash curl -H "Authorization: Bearer ACCESS_TOKEN" https://{{uns_url}}/api/v1/... ``` Token endpoint is a Keycloak realm URL (`/auth/realms/standalone/...`) - different from the LE OAuth2 proxy endpoint (`/auth/v3/oauth/token`). --- ## 6. Variable System Variables use the `{{variableName}}` syntax in URLs, headers, and body content. They are defined in the companion environment file. Resolve them before making requests. ### Core variables (always required) | Variable | Used for | Example value | | --------------------- | -------------------- | ------------------------- | | `edgeUrl` | LE base URL | `https://192.168.1.100` | | `apiToken` | Basic auth (LE) | `myApiToken123` | | `oauth_client_id` | OAuth2 client ID | `my-client-id` | | `oauth_client_secret` | OAuth2 client secret | `my-secret` | | `LEM_URL` | LEM base URL | `https://10.0.0.50` | | `LEM_AdminApiToken` | LEM auth token | `lemToken...` | | `LEM_adminURL` | LEM admin port | `https://10.0.0.50:8446` | | `uns_url` | UNS base URL | `https://uns.example.com` | | `uns_oauth_client_id` | UNS OAuth2 client ID | `uns-client` | | `uns_oauth_username` | UNS OAuth2 username | `admin` | | `uns_oauth_password` | UNS OAuth2 password | `secret` | ### Resource ID variables (needed for specific endpoints) | Variable | Used by | | ------------------------------- | ---------------------------------------------------- | | `deviceID` | Device-specific DeviceHub calls | | `dh_browse_task_id` | Browse task operations | | `digital_twins_model_id` | Digital Twins model operations | | `digital_twins_instance_id` | Digital Twins instance operations | | `flow_id` | Flows Manager operations | | `analytics_single_processor_id` | Analytics processor operations | | `marketplace_single_app` | Catalog app operations | | `integration_instance_id` | Integration instance operations | | `opc_node_id` | OPC UA node operations | | `user-id` | System user operations | | `lem_project_id` | LEM Bridge Token URL path (`/api/v1/edge/{id}/...`) | | `lem_edge_device_id` | LEM Bridge Token URL path (`/api/v1/edge/.../{id}/`) | --- ## 7. GraphQL Endpoint Pattern Several LE services expose their API exclusively via GraphQL at a single POST endpoint: | Service | Endpoint | | --------------------- | -------------------------------- | | DeviceHub | `POST {{edgeUrl}}/devicehub/v2` | | Digital Twins | `POST {{edgeUrl}}/digital-twins` | | Analytics | `POST {{edgeUrl}}/analytics/v3` | | Integration/Streaming | `POST {{edgeUrl}}/cc/v2` | | OPC UA | `POST {{edgeUrl}}/opcua/v2` | The operation name is in the GraphQL query itself. To understand what a specific request does, read `request.body.graphql.query` (or `request.body.raw` if mode is `raw`) - the query name and selection set describe the operation and return fields. **Example - "List Devices" request body:** ```json { "mode": "graphql", "graphql": { "query": "{\n ListDevices {\n ID\n Name\n Status\n DriverID\n }\n}", "variables": "{}" } } ``` GraphQL mutations (create/update/delete) use the `mutation` keyword: ```graphql mutation { CreateDevice(input: { Name: "...", DriverID: "..." }) { ID Name } } ``` ### Prometheus metrics endpoints (REST exception) Each GraphQL service also exposes a separate REST endpoint for Prometheus scraping. These return plain text in Prometheus exposition format, not JSON. They use basic auth like all other LE REST endpoints. | Service | Prometheus endpoint | | ------------ | --------------------------------------------------------------------------------------------------- | | DeviceHub | `GET {{edgeUrl}}/devicehub/metrics` | | DataHub | `GET {{edgeUrl}}/stats/metrics` | | Analytics | `POST {{edgeUrl}}/analytics/v3` (same URL as GraphQL - check request body for the Prometheus query) | | Applications | `GET {{edgeUrl}}/apps/metrics` | | Integration | `GET {{edgeUrl}}/cc/metrics` | These appear in the collection as `*Prometheus Metrics` subfolders inside each service category. **Skip them** unless you are specifically asked about monitoring or metrics scraping. --- ## 8. Efficient LLM Navigation Strategies **Use the [Quick Keyword Lookup](#quick-keyword---location-lookup) and [Common Workflows](#10-common-workflows-cross-endpoint) sections first.** The strategies below are for the rare case where those tables don't cover your specific endpoint and you need to inspect the raw collection. In that case, apply these strategies to read only the single node you need -- never the collection root. ### What to skip to avoid overloading context - Skip `response[].header[]` arrays - they are HTTP response headers from recorded examples, not useful for constructing requests - Skip disabled query parameters: `query[].disabled == true` - Skip `_postman_previewlanguage` and `_postman_id` fields - these are Postman UI metadata - For older versions (3.16.x, LEM 2.26.x), only read them if the user specifically asks about those versions ### Strategy A: "I need to do X with product Y" 1. Identify product: LE -> index 0, LEM -> index 2, UNS -> index 4 2. Identify category from the Category Maps table above 3. Drill into the folder tree by name 4. Read only matching request nodes - skip `response[]` unless you need example shapes ### Strategy B: "What endpoints exist for feature X?" Scan folder names at depth 2 only. Each subfolder name describes a feature domain. Read request `name` fields (not full request bodies) to build an index before diving in. ### Strategy C: "Show me how to call endpoint X" 1. Find the endpoint by name traversal 2. Read `request.method`, `request.url.raw`, `request.body` 3. Read `request.auth` (or walk up to parent folder auth if absent) 4. Read `request.description` for context 5. Read `response[0].body` for expected response shape ### Strategy D: "What variables do I need?" Extract all `{{varName}}` occurrences from `request.url.raw` and `request.body.raw` / `request.body.graphql.query` for the endpoints you plan to call. Cross-reference with the variable table above to know which ones are required credentials vs resource IDs. --- ### Quick Keyword -> Location Lookup If a term is ambiguous (Browse, Model, Instance, Template, Discovery), see section 9 before navigating. #### Devices & Tags (LE) | If asked about... | Navigate to | Key endpoint(s) | | ----------------------------------------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------- | | register types, tag types, valid value types, read-only vs writable registers | DeviceHub -> Register Types - Driver Reference | description-only folder per driver; read the matching entry's `description` field | | driver-specific device creation example, how to create a Modbus/OPC UA/EtherNet-IP device | DeviceHub -> Create Device - Driver Examples | 146 per-driver request examples; each has a pre-filled body showing required properties | | list devices, get device status | DeviceHub -> Devices | List Devices, Device Connection Status | | create device, driver config, connect industrial device | DeviceHub -> Devices + Drivers | Create New Device, Get Driver Template by DriverID | | start/stop device polling, enable/disable device | DeviceHub -> Devices | Start Device, Stop Device, Enable/Disable Device Data Storage | | delete device | DeviceHub -> Devices | Delete Devices graphQL (bulk), Delete Device Rest (single) | | OPC UA device discovery, find OPC UA endpoints on a device | DeviceHub -> Devices | Device Discovery Tool _(OPC UA Advanced driver only)_ | | list tags, create tag, bulk import tags, CSV upload | DeviceHub -> Tags | List All Tags, Create Tag, Upload CSV, Download Tags CSV | | tag/register live status, is tag reading data | DeviceHub -> Tags | Register/Tag Status | | bulk tag discovery, browse address space, create tags from browse | DeviceHub -> Browse | Create Browse Task -> Start Browse Task -> Cart Add Items -> Cart Create All Registers | | which drivers support browse, browse-capable drivers, DynamicBrowse | DeviceHub -> Browse (folder description) | 38 drivers listed with Browse/DynamicBrowse/StreamBrowse support matrix | | scan network, find devices on LAN, asset discovery | DeviceHub -> Asset Discovery | Scan for Devices/Assets on eth0, Devices on Network | | list drivers, available protocols, supported driver IDs | DeviceHub -> Drivers | List of Drivers by DriverID and GroupID, List all Details of Drivers | #### Data & Analytics (LE) | If asked about... | Navigate to | Key endpoint(s) | | ---------------------------------------------------- | ---------------------- | --------------------------------------------------------------- | | live tag values, current sensor reading | DeviceHub -> Tags | Register/Tag Status | | historical data, time-series query, InfluxDB, trends | DataHub | Timeseries DB Info, List DBs | | create/delete InfluxDB database or user | DataHub | Create Database, Create User, Delete Database | | analytics processor, data pipeline, ML inference | Analytics -> Instances | Create New Processor, Get Processor Instances, Invoke Processor | | AI model, TensorFlow, upload ML model | Analytics -> Models | Add AI Model, Step 1/2/3 Upload TensorFlow Model | | flow, Node-RED, data routing | Flows Manager | Create Flow, List Flows, Start Flow, Stop Flow | #### Applications & Containers (LE) | If asked about... | Navigate to | Key endpoint(s) | | ------------------------------------------- | --------------------------------------- | ---------------------------------------------------------------- | | deploy app, install catalog app, launch app | Applications -> Marketplace | Launch a Catalog App, Get Marketplace Apps | | start/stop/remove catalog app | Applications -> Catalog Apps | Start a Catalog App, Stop a Catalog App, Uninstall a Catalog App | | Docker container lifecycle | Applications -> Containers | Run a Container, Start/Stop/Pause/Remove | | Docker image pull, upload image, FTP image | Applications -> Images | Pull an Image, Upload an Image, Upload Image from FTP Folder | | private container registry | Applications -> Registry | Create Registry, List Registries | | Docker network, container networking | Applications -> Networks | Create A Network, Connect Container to a Network | | Docker volume | Applications -> Volumes | List Volumes, Remove Single Volume | | add marketplace catalog, sync marketplace | Applications -> Marketplace / Configure | Create New Marketplace Catalog, Marketplace Sync | #### Integration & OPC UA (LE) | If asked about... | Navigate to | Key endpoint(s) | | ----------------------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------- | | cloud integration, Azure IoT, AWS IoT, MQTT bridge, streaming connector | Integration -> Streaming | List Instances, Update Instance, Manage Topics | | create cloud connector, create integration instance, provider config | Integration -> Create Instance - Provider Examples | Create Instance - {ProviderName} (45 providers, one example each) | | provider schema, config fields, required fields, enum values | Integration -> Provider Schemas - Reference | Provider Schema - {ProviderName} (45 providers, full GetProviderSchema) | | enable/disable topic subscription, cloud topic mapping | Integration -> Streaming -> Manage Topics | Enable/Disable Topic/s Subscription, Create Subscription | | cloud object storage, S3, Azure Blob | Integration -> Object | Get Cloud Storage Providers, Get Cloud Storage Jobs | | OPC UA server start/stop, OPC UA config | OPC UA -> Management | Start OPC UA Service, Stop OPC UA Service, Get/Change Service Configuration | | OPC UA security, certificates, user auth | OPC UA -> Management | Get/Change Security and Authentication Settings, List Users | | OPC UA node hierarchy, browse OPC UA tree | OPC UA -> Hierarchy | Get Node Root, Get Nodes by Paths | | import DeviceHub tags into OPC UA | OPC UA -> Hierarchy | Import ALL DH Tags, Import all DH Tags of a Device, Import Some DH Tags | | manually add OPC UA node | OPC UA -> Hierarchy | Add Node - Device / Folder / Tag | | export/import OPC UA hierarchy | OPC UA -> Hierarchy | Export As JSON, Import JSON | #### System & Security (LE) | If asked about... | Navigate to | Key endpoint(s) | | ------------------------------------------------ | --------------------------------------------------------- | --------------------------------------------------------------------------- | | user management, create user, update user | System -> Access Control -> Users | Create an User, List Users, Update an User | | user groups, RBAC roles | System -> Access Control -> Users | Create User Group, Get User Roles, Add New Role | | API key, API credentials | System -> Access Control -> Tokens -> API Credentials | Create API Key, Get API Keys | | MQTT access account, MQTT credentials, NATS | System -> Access Control -> Tokens -> Access Accounts | Create Access Account, Add Read/Write Topic | | NATS proxy enable/disable | System -> Access Control -> Tokens -> NATS Proxy | Enable/Disable NATS Proxy | | LDAP, Active Directory, SSO, external auth | System -> Access Control -> LDAP-AD Auth | Create New Auth Provider, Test Configuration | | password policy, change password | System -> Access Control -> Password Policy | Change Password, Show Current or Default Password Policy | | license, activation, online activation | System -> Activation -> License | Online License Activation, List Installed License/s | | cloud registration, register with cloud | System -> Activation -> Cloud Activation | Register With Cloud, Set Cloud URL | | reboot, shutdown, factory reset | System -> Device Management -> Device Management | Reboot Device, Gracefully Shutdown Device, Reset Device to Factory Settings | | software update, firmware OTA | System -> Device Management -> Device Management | Apply SW Update, Download from URL | | backup, restore, device template | System -> Device Management -> Backup/Restore / Templates | Step 1/2 Apply Backup, Apply Template | | FTP service, SSH service, enable/disable service | System -> Device Management -> System Services | Start and Enable Service, FTP Service Status | | disk space policy, storage monitoring | System -> Device Management -> Disk Space Policy | Set/Get Disc Space Monitoring Policy | | SSL certificate, TLS, custom CA, identity cert | System -> Network -> Certificates | Install Identity Certificate, Step 1/2 Upload Custom CA Certificate | | WiFi config, wireless network, connect to WiFi | System -> Network -> WiFi | Connect to WiFi Network, List Networks in Interface | | DNS, NTP, hostname, timezone, network interface | System -> Network -> Configure | Set DNS Resolvers, Set NTP Servers, Set Friendly Host Name, Set Timezone | | firewall rules, port access | System -> Network -> Firewall | Create Firewall Rule, Get Firewall Rules | | packet capture, tcpdump | System -> Network -> Packet Capture | Start Packet Capture, Packet Capture Status | | modem, cellular, LTE, mobile broadband | System -> Network | List Available Modems, Mobile Broadband Info | | external storage, CIFS, NFS, network share | System -> External Storage | Create New CIFS Mount, Create FTP Mount Point | | support bundle, diagnostics, service status | System -> Support | Generate and Download Support Bundle, DeviceHub Status | | serial port, RS232, RS485, SLCAN | System -> Info | Serial Interfaces Info, SLCAN Info | | CPU/memory/storage info, host info | System -> Info / Dashboard | CPU Info, Memory Info, Storage Info, Host Device Info | | events, event log | System -> Events | Get Events | | digital twin asset model (on LE) | Digital Twins -> Models | List Models, Create Model, Clone a Model | | digital twin instance (on LE) | Digital Twins -> Instances | Create Instance, Get Instances, Set Instance State | #### LEM - Edge Fleet Management (index 2) | If asked about... | Navigate to | Key endpoint(s) | | ------------------------------------------ | ---------------------------------------------------------------------- | ---------------------------------------------------------------- | | list edge devices, device status in LEM | Edge Lifecycle Management -> Edge Devices -> General Devices Page | Devices, Device Version | | per-device details, metrics, logs | Edge Lifecycle Management -> Edge Devices -> Device Details | Current Device Details, Device Metrics, App Logs | | manage apps on a specific edge from LEM | Edge Lifecycle Management -> Edge Devices -> Device Details -> Apps | Start/Stop Application, Apps List for Device | | deploy app to edge from LEM | Edge Lifecycle Management -> Applications | Launch Application to Edge Device | | reboot/manage edge from LEM | Edge Lifecycle Management -> Edge Devices -> Device Details -> Manage | Reboot Device, Start/Stop Service | | backup/restore edge from LEM | Edge Lifecycle Management -> Edge Devices -> Device Details -> Backups | Make Device Backup, Restore from Backup | | activate new edge, zero touch provisioning | Edge Lifecycle Management -> Activation | Add Activation Config, List ZeroTouch Configs | | sites, project structure | Edge Lifecycle Management -> Sites | List Project Sites, Add Site | | software update across fleet, OTA at scale | Edge Lifecycle Management -> Software Update | Software Update History | | LEM alerts, triggers, notifications | Edge Lifecycle Management -> Alerts | Create Trigger - Event/Metrics, Add Action - Email/Slack/Webhook | | LEM RBAC, device users, device groups | Edge Lifecycle Management -> RBAC | Create Device User, Get Device Roles, Get Device Groups | | LEM MQTT credentials, project MQTT | Edge Lifecycle Management -> Settings | Credentials - MQTT, Credentials - Topics | | remote access, VPN, peer-to-peer | Edge Lifecycle Management -> Remote Access | Peer List, Project Details | | AI/ML model deploy to edge from LEM | Edge Lifecycle Management -> AI/ML Models | Deploy ML model, Upload New Model to LEM | | certificates for edge devices (LEM) | Edge Lifecycle Management -> Certificates | Issue New Certificate, Upload Custom Certificate | | licenses per device, license summary | Edge Lifecycle Management -> Licenses | License Summary - Status, List Device Licenses | | marketplace catalog management in LEM | Edge Lifecycle Management -> Features -> Marketplace Catalog | Catalog Applications, Add Release to an Application | | LEM templates, configuration templates | Edge Lifecycle Management -> Templates | Templates List, Create Template | | companies, projects, company list | Companies | Company List with Details, Projects Within Company | | digital twin models (LEM/fleet level) | Digital Twins -> Asset Management | Get DigitalTwin Models, Create DigitalTwin Model | #### LEM - Admin Console (index 2, port 8446) | If asked about... | Navigate to | Key endpoint(s) | | ---------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------ | | LEM backup/restore, export/import config | Admin Console APIs -> Admin Console Settings -> Backup / Export/Import | Create Backup, Export Configuration | | LEM upgrade, software version | Admin Console APIs -> Admin Console Settings -> Upgrade | Upgrade List, Upload UPD File | | LEM users, teams, admin user management | Admin Console APIs -> Admin Console Settings -> Users | Create User, User List | | LEM admin tokens | Admin Console APIs -> Admin Console Settings -> Tokens | Create Admin Token, Create Token With Scopes | | Clickhouse, data warehouse, analytics DB | Admin Console APIs -> Integration -> Clickhouse | Clickhouse User List, Enable/Disable Clickhouse Port | | Kafka topics, Kafka users, streaming | Admin Console APIs -> Integration -> Kafka | Kafka Topics, Kafka User List | | Git sync, GitOps, template from git | Admin Console APIs -> Integration -> Git | Create/Update Git Provider Config, Sync Git Template | | syslog, log forwarding, remote logging | Admin Console APIs -> Integration -> Syslog | Enable/Disable Logs Forwarding, Syslog Settings | | AI assistant config (LEM) | Admin Console APIs -> Integration -> AI Assistant | Get/Update AI Assistant Config | | Prometheus integration (LEM) | Admin Console APIs -> Integration -> Prometheus | Enable/Disable Prometheus URL, Set Alert Manager URL | | Docker registry (LEM level) | Admin Console APIs -> Docker Registry | Image List, Docker Pull | | LEM network/DNS/NTP/proxy (admin) | Admin Console APIs -> Admin Console Settings -> Network | DNS, NTP, Proxy Settings | | LEM license type, license features | Admin Console APIs -> Admin Console Settings -> Licenses | License Type, Switch License Type | | edge remote networks, VPN config | Admin Console APIs -> Edge Devices -> Edge Remote Networks | Create Network, Statistics | | edge device templates (LEM admin) | Admin Console APIs -> Edge Devices -> Edge Device Templates | Edge Device Template List, Upload Template | | instance-level alerts and triggers (admin) | Admin Console APIs -> Instance Alerts | Create/Update Trigger, Create Instance Action Template | | data lifecycle, purge policy, disk usage (LEM) | Admin Console APIs -> Data Lifecycle | Purge Policy, Create Purge Policy | | LEM logs, system logs | Admin Console APIs -> Logs | Get Logs (Paginated), Get Log Contexts | | license server management | Admin Console APIs -> License Server Mgmt | License Usage Summary, License Clients | #### Litmus UNS (index 4) | If asked about... | Navigate to | Key endpoint(s) | | ---------------------------------------------- | ------------------ | ----------------------------------------------------------- | | UNS namespace, namespace hierarchy, topic tree | UNS | Namespace, Topics, Rename Namespace, Update Namespace Rules | | MQTT broker config, server settings | MQTT -> Interfaces | Server Config | | MQTT clients, connected clients | MQTT -> Clients | List Clients and Connections, Client Details | | UNS accounts, MQTT credentials | Security / UNS | Create Account, Get Accounts, Add Permission to Account | | LE activation token for UNS enrollment | Security | Create LitmusEdge Activation Token | | Kafka integration with UNS | Integrations | Get Kafka Integrations, Kafka Update and (re)Connect | | UNS dashboard, version, stats | Dashboard | Dashboard Data, Get Version | --- ## 9. Term Disambiguation Several terms are reused across different subsystems. Resolve ambiguity before navigating. ### "Browse" | Context | Meaning | Location | | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | DeviceHub -> **Browse** (folder) | Automated address-space discovery tool: creates a "browse task" that connects to a device, crawls its tag tree, lets you select tags into a cart, then bulk-creates them as registers. The folder description lists all 38 drivers that support Browse (with DynamicBrowse/StreamBrowse capabilities per driver). | DeviceHub -> Browse | | DeviceHub -> Tags -> **Browse Tags** | Filters/searches already-created tags (not address-space discovery) | DeviceHub -> Tags -> Browse Tags | | OPC UA -> Hierarchy -> **Get Node Root / Get Nodes by Paths** | Reads the OPC UA server's exposed node hierarchy (after tags have been imported) | OPC UA -> Hierarchy | ### "Discovery" | Context | Meaning | Location | | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | DeviceHub -> Asset Discovery | Network-layer scan - finds IP devices on the LAN (Modbus, BACnet, etc.) | DeviceHub -> Asset Discovery | | DeviceHub -> Devices -> **Device Discovery Tool** | OPC UA endpoint discovery - finds OPC UA server endpoints on a specific device. **OPC UA Advanced driver (ID `2372E68F-...`) only** | DeviceHub -> Devices -> Device Discovery Tool | ### "Driver" An industrial protocol handler (OPC UA, Modbus, EtherNet/IP, DNP3, etc.) - not an OS/hardware driver. A **Device** is an instance of a driver with specific connection settings. One Driver can have many Devices. ### "Register" vs "Tag" These are synonymous. "Register" is the legacy term from early Litmus; "Tag" is the current UI term. The API uses both interchangeably. `CreateTag` = `CreateRegister` conceptually. ### "Template" | Context | Meaning | Location | | ---------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | Driver Template | JSON schema of required config fields for a driver - fetch before creating a Device | DeviceHub -> Drivers -> Get Driver Template by DriverID | | Device Template (LEM) | Saved LE device configuration snapshot for reuse across fleet | LEM -> Edge Lifecycle Management -> Templates | | Analytics Processor metadata | Processor type definition (not called "template" in API, but served by Get All (Supported) Processors Metadata) | Analytics -> Instances | ### "Model" | Context | Meaning | Location | | --------------------- | ------------------------------------------------------------------ | ------------------------------------------------ | | Digital Twins Model | ISA-95 asset template (defines structure, attributes, hierarchy) | Digital Twins -> Models | | Analytics AI/ML Model | Uploaded TensorFlow/ONNX model file used by an analytics processor | Analytics -> Models | | LEM AI/ML Model | Same ML model file managed at fleet level | LEM -> Edge Lifecycle Management -> AI/ML Models | ### "Instance" | Context | Meaning | Location | | ------------------------------ | ---------------------------------------------------------------- | -------------------------- | | Digital Twins Instance | A deployed asset based on a Digital Twins Model | Digital Twins -> Instances | | Analytics Instance / Processor | A running analytics processor within a group | Analytics -> Instances | | Integration Instance | A configured streaming connector (e.g. Azure IoT Hub connection). See **Create Instance - Provider Examples** (45 providers) for CreateInstance mutations and **Provider Schemas - Reference** for config field schemas. | Integration -> Streaming | ### "Cart" (DeviceHub Browse) Intermediate selection buffer during a Browse session. After a Browse Task crawls a device's address space, you add nodes to the Cart, optionally set properties, then call **Cart Create All Registers** to materialize them as tags. ### "Cloud Storage" vs "DataHub" - **Integration -> Object** = outbound cloud object storage connectors (S3, Azure Blob) - data _leaving_ the edge - **DataHub** = local InfluxDB time-series store on the edge - data _stored locally_ ### "Access Account" vs "API Key" | Type | Used for | Location | | ------------------------- | --------------------------------------------------------------- | ----------------------------------------------------- | | Access Account | MQTT/NATS topic-scoped credentials (read/write specific topics) | System -> Access Control -> Tokens -> Access Accounts | | API Key / API Credentials | REST API authentication token | System -> Access Control -> Tokens -> API Credentials | --- ## 10. Common Workflows (Cross-Endpoint) > **Full chain-of-API reference** (all multi-step UI workflows): `https://api.litmus.io/workflow-chains.md` > Use that document when you need to understand what sequence of API calls a single UI action triggers (e.g. "Apply Template", "Restore Backup", "Upload Model", "Add Tag", "Browse Tags"). ### Connect an industrial device and read its tags ``` 1. POST /devicehub/v2 -> ListDrivers (find the right driver ID) 2. POST /devicehub/v2 -> GetDriverTemplate (get required config fields) 3. POST /devicehub/v2 -> CreateDevice (create with driver config) 3b. DeviceHub -> Register Types - Driver Reference -> find entry for the driver (check which register types and value types are valid before calling CreateTag; keywords: supported registers, tag types, register compatibility, CreateRegisters properties, valid value types, read-only tags, writable tags) 4. POST /devicehub/v2 -> CreateTag (define tags/registers) 5. POST /devicehub/tags/read (read live values) [REST endpoint] ``` ### Deploy and run an edge application ``` 1. GET Applications -> Configure -> List Marketplace Catalogs (list configured marketplaces) 2. GET Applications -> Marketplace -> Get Marketplace Apps (browse available apps) 3. POST Applications -> Marketplace -> Launch a Catalog App (install and start) 4. GET Applications -> Catalog Apps -> Get Running Catalog Apps (check running status) 5. PUT Applications -> Catalog Apps -> Start a Catalog App (start if not running) PUT Applications -> Catalog Apps -> Stop a Catalog App (stop) DELETE Applications -> Catalog Apps -> Uninstall a Catalog App (remove) ``` ### Configure OPC UA server with device tags ``` 1. POST /opcua/v2 -> GetNodeRoot (see current hierarchy) Option A - import all tags: 2a. POST /opcua/v2 -> ImportAllDHTags (import all DeviceHub tags into OPC UA) Option B - selective import: 2b. POST /opcua/v2 -> ImportSomeDHTags (selective import) 3. POST /opcua/v2 -> StartOPCUAService (start the server) 4. POST /opcua/v2 -> GetServiceConfiguration (verify config) ``` --- ## 11. Error Handling | HTTP Code | Meaning | Typical cause | | --------- | --------------------- | ---------------------------------------- | | 200 | OK | Success | | 201 | Created | Resource created | | 400 | Bad Request | Malformed body or missing required field | | 401 | Unauthorized | Missing, expired, or invalid token | | 403 | Forbidden | Token lacks required RBAC permission | | 404 | Not Found | Resource ID does not exist | | 409 | Conflict | Duplicate resource name | | 500 | Internal Server Error | LE service error | **On 401**: Fetch a new token and retry once before failing. --- ## 12. Additional Resources - **Product Documentation**: [docs.litmus.io](https://docs.litmus.io) - **Pre-built Solutions catalog**: [docs.litmus.io/solutions](https://docs.litmus.io/solutions) - **OAuth2 Setup Guide**: [docs.litmus.io/litmusedge/how-to-create-and-use-oauth-20-tokens-in-litmus-edge](https://docs.litmus.io/litmusedge/how-to-create-and-use-oauth-20-tokens-in-litmus-edge) - **LEM Bridge Token Setup**: [docs.litmus.io/edgemanager/lem-admin-console/product-features/admin-console-settings/tokens/add-tokens#step-4-edge-api-bridge-option](https://docs.litmus.io/edgemanager/lem-admin-console/product-features/admin-console-settings/tokens/add-tokens#step-4-edge-api-bridge-option) - **Full API Collection JSON** _(for tooling and human reference -- do not fetch as an agent, see [STOP section](#stop-do-not-fetch-collectionsjson))_: [api.litmus.io/collections.json](https://api.litmus.io/collections.json)