Litmus Edge API Documentation (4.0.x)

Litmus Edge is the edge runtime deployed on industrial gateway hardware. It talks to industrial devices, stores data locally, runs containerized apps, and publishes to cloud, MQTT, and REST destinations. This page indexes the full API reference: 866 endpoints across ten components, a mix of REST and GraphQL behind a single base URL.

Authentication

Every Litmus Edge API call requires an OAuth2 Bearer token, obtained with the client credentials grant.

Request

POST {{edgeUrl}}/auth/v3/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=<id>&client_secret=<secret>

Response

{
  "access_token": "...",
  "expires_in": 3600,
  ...
}

Send the returned access_token as Authorization: Bearer <token> on every request, and refresh it before expires_in elapses.

Use the path above exactly. Do not call the Keycloak-style auth path; {{edgeUrl}}/auth/v3/oauth/token is the correct token endpoint.

The base URL variable {{edgeUrl}} is typically https://<edge-ip>:8443. The credentials variables (oauth_client_id, oauth_client_secret) and every other placeholder used in the reference are catalogued in the variables reference.

API components

Each component below links to a full endpoint reference with request and response schemas, examples, and error tables.

Dashboard

Service health, host info, and CPU, memory, network, and storage utilization metrics.

REST View in API collection

DeviceHub

Connect industrial devices (PLCs, sensors, OPC UA servers): drivers, devices, tags, bulk tag discovery (Browse), and network asset discovery. Includes a per-driver example and register reference for all 146 supported drivers.

GraphQL View in API collection

Digital Twins

Asset models and instances with static and dynamic attributes, transformations, and hierarchies.

GraphQL View in API collection

DataHub

Local time-series storage and statistics for tag data.

REST View in API collection

Flows Manager

Manage the embedded Node-RED flow engine: flows, deployment, and status.

REST View in API collection

Analytics

Processor pipelines (sources, transforms, KPIs, sinks), groups, variables, and AI/ML model management.

GraphQL View in API collection

Applications

Docker applications on the edge: marketplace, catalog apps, containers, images, volumes, networks, and registries.

REST View in API collection

Integration

Push tag data outward to 45 cloud and database providers (Kafka, Azure IoT, AWS IoT, InfluxDB, S3, and more), with a full config schema per provider.

GraphQL View in API collection

OPC UA Server

Expose edge tags upstream through the embedded OPC UA server: hierarchy, node management, and connections.

GraphQL View in API collection

System

Edge administration: system info, activation and licensing, configuration templates and backups, networking and certificates, external storage, users and RBAC, events, and support packages.

REST View in API collection

The whole product in one place: Litmus Edge in the API collection.

Common multi-step tasks

If your task spans several calls, start from the step-by-step guide instead of a single component:

The complete list of sixteen guides is on the workflows page.

Reference material