Litmus API - Environment Variables Reference
You are at https://api.litmus.io/reference/variables.md
Generated from the Postman environment "LE, LEM, LUNS Environment".
This is a reference table, not a router. For routing start at /agents.md.
Variables are referenced in requests as {{variableName}}. They fall into two classes:
- Set-once configuration - you edit these before anything works (URLs, credentials). Only a handful.
- Captured at runtime - identifiers returned by one call and fed into the next. Do not hand-edit; the workflow chains under /workflows/agents.md fill these for you.
Secrets are flagged. Never commit real secret values.
Set-once configuration
Litmus Edge (LE)
| Variable |
Example |
Secret |
Description |
edgeUrl |
https://{Edge_IP_address} |
no |
Base URL of the Litmus Edge instance. Every LE request is built from this. |
oauth_client_id |
{oauth_client_id} |
no |
OAuth2 client-credentials client ID. Exchanged at /auth/v3/oauth/token for a Bearer token. |
oauth_client_secret |
{oauth_client_secret} |
yes |
OAuth2 client-credentials secret. Pairs with oauth_client_id. |
apiToken |
{Edge_api_token} |
yes |
Legacy header-token credential for LE. Prefer OAuth2 where available. |
Litmus Edge Manager (LEM)
| Variable |
Example |
Secret |
Description |
LEM_URL |
https://{EM_IP_adress} |
no |
Base URL of the LEM management plane (port 443). |
LEM_adminURL |
https://{EM_IP_adress}:8446 |
no |
LEM admin console URL (port 8446). |
LEM_AdminApiToken |
{EM_admin_API_token} |
yes |
Admin API token sent as the X-AuthToken header on LEM admin calls. |
Litmus Unify (LUNS)
| Variable |
Example |
Secret |
Description |
uns_url |
{uns_url} |
no |
Base URL of the LUNS / Unified Namespace instance. |
uns_oauth_client_id |
ide-ui |
no |
OAuth2 client ID for LUNS (password grant). Defaults to ide-ui; use that unless told otherwise. |
uns_oauth_client_secret |
(empty) |
no |
OAuth2 client secret for LUNS (password grant). Empty by default; send blank or omit. |
uns_oauth_username |
{uns_oauth_username} |
no |
LUNS OAuth2 username (password grant). |
uns_oauth_password |
{uns_oath_password} |
yes |
LUNS OAuth2 password (password grant). |
Captured at runtime
These hold IDs and names produced by earlier API calls. Leave them blank until a call populates them.
DeviceHub (LE)
| Variable |
Secret |
Description |
deviceID |
no |
Device identifier |
device_id |
no |
Device identifier |
dh_browse_task_id |
no |
DeviceHub browse task identifier |
register_id |
no |
Register identifier |
task_id |
no |
Task identifier |
Digital Twins (LE)
| Variable |
Secret |
Description |
digital_twins_clone |
no |
Digital twins clone |
digital_twins_dynamic_attribute_id |
no |
Digital twins dynamic attribute identifier |
digital_twins_instance |
no |
Digital twins instance |
digital_twins_instance_id |
no |
Digital twins instance identifier |
digital_twins_model |
no |
Digital twins model |
digital_twins_model_id |
no |
Digital twins model identifier |
digital_twins_static_attribute_id |
no |
Digital twins static attribute identifier |
digital_twins_transformation_id |
no |
Digital twins transformation identifier |
DataHub (LE)
| Variable |
Secret |
Description |
db_measurement |
no |
Database measurement |
db_name |
no |
Database name |
db_source_type |
no |
Database source type |
db_username |
no |
Database username |
source_type |
no |
Source type |
Flows (LE)
| Variable |
Secret |
Description |
flow_id |
no |
Flow identifier |
Analytics & AI (LE)
| Variable |
Secret |
Description |
AI_Model_API_Key |
yes |
AI model API key |
AI_Model_Provider_Name |
no |
AI model provider name |
AI_Model_URL |
no |
AI model URL |
AI_Model_Unique_Name |
no |
AI model unique name |
AI_Provider_Model_Name |
no |
AI provider model name |
TensorFlow_model_name |
no |
TensorFlow model name |
TensorFlow_model_size |
no |
TensorFlow model size |
TensorFlow_model_upload_id |
no |
TensorFlow model upload identifier |
analytics_connection_type |
no |
Analytics connection type |
analytics_group_name |
no |
Analytics group name |
analytics_parameter_key |
no |
Analytics parameter key |
analytics_parameter_value |
no |
Analytics parameter value |
analytics_single_processor_id |
no |
Analytics single processor identifier |
analytics_single_processor_id_another |
no |
Analytics single processor id another |
analytics_wire_definition |
no |
Analytics wire definition |
Applications & Marketplace (LE)
| Variable |
Secret |
Description |
MPC_release_name |
no |
MPC release name |
marketplace_app_component |
no |
Marketplace app component |
marketplace_catalog_application_id |
no |
Marketplace catalog application identifier |
marketplace_catalog_id |
no |
Marketplace catalog identifier |
marketplace_catalog_version |
no |
Marketplace catalog version |
marketplace_container_id |
no |
Marketplace container identifier |
marketplace_id |
no |
Marketplace identifier |
marketplace_image_id |
no |
Marketplace image identifier |
marketplace_network_id |
no |
Marketplace network identifier |
marketplace_registry_id |
no |
Marketplace registry identifier |
marketplace_single_app |
no |
Marketplace single app |
marketplace_volume_name |
no |
Marketplace volume name |
Integration (LE)
| Variable |
Secret |
Description |
integration_cloudprovider_id |
no |
Integration cloud provider identifier |
integration_instance_id |
no |
Integration instance identifier |
integration_local_topic_name |
no |
Integration local topic name |
integration_remote_topic_name |
no |
Integration remote topic name |
integration_topic_id |
no |
Integration topic identifier |
OPC UA (LE)
| Variable |
Secret |
Description |
opc_node_id |
no |
OPC node identifier |
opc_username |
no |
OPC username |
System & Access Control (LE)
| Variable |
Secret |
Description |
access_account_api_key |
yes |
Access account API key |
access_account_id |
no |
Access account identifier |
access_read_topic |
no |
Access read topic |
access_write_topic |
no |
Access write topic |
api_key_id |
yes |
API key identifier |
attached_storage_name |
no |
Attached storage name |
auth_provider_groupId |
no |
Auth provider group identifier |
auth_provider_id |
no |
Auth provider identifier |
cifs_mount_name |
no |
CIFS mount name |
config_session_id |
no |
Config-template upload session id, returned by POST /config/session and reused by the upload (PATCH /config/session/{id}) and apply (PUT /config/template/{id}) calls |
firewall-rule-id |
no |
Firewall rule identifier |
ftp_mount_name |
no |
FTP mount name |
new-user-role |
no |
New user role |
offline_license_activation |
no |
Offline license activation |
online_license_activation |
no |
Online license activation |
service_name |
no |
Service name |
system-user-role-id |
no |
System user role identifier |
uns_connector_name |
no |
UNS connector name |
update-user-role |
no |
Update user role |
user-group |
no |
User group |
user-id |
no |
User identifier |
user-name |
no |
User name |
user_id |
no |
User identifier |
Software Update (LEM)
| Variable |
Secret |
Description |
sw-checksum |
no |
Software checksum |
sw-update-algorithm |
no |
Software update algorithm |
sw-update-location |
no |
Software update location |
Admin Console (LEM)
| Variable |
Secret |
Description |
LEM_admin_exportpassword |
yes |
LEM admin exportpassword |
LEM_admin_subnetId |
no |
LEM admin subnet identifier |
LEM_admin_teamname |
no |
LEM admin teamname |
LEM_admin_tokenhash |
yes |
LEM admin tokenhash |
LEM_admin_username |
no |
LEM admin username |
Digital Twins (LEM)
| Variable |
Secret |
Description |
LEM_DT_Model_ID |
no |
LEM DT model identifier |
LEM_DT_Model_RootNodeID |
no |
LEM DT model root node identifier |
Fleet & Projects (LEM)
| Variable |
Secret |
Description |
LEM_INSTANCE_ALERT_SOURCE_TYPE |
no |
LEM instance alert source type |
activation_code |
no |
Activation code |
alert_id |
no |
Alert identifier |
company_name |
no |
Company name |
device_app_id |
no |
Device app identifier |
device_service |
no |
Device service |
project_entry_id |
no |
Project entry identifier |
project_id |
no |
Project identifier |
site_id |
no |
Site identifier |
template_id |
no |
Template identifier |
template_name |
no |
Template name |
trigger_id |
no |
Trigger identifier |
Accounts & Topics (LUNS)
| Variable |
Secret |
Description |
uns_account_id |
no |
UNS account identifier |
uns_account_name |
no |
UNS account name |
uns_account_permission |
no |
UNS account permission |
uns_client_id |
no |
UNS client identifier |
uns_namespace_id |
no |
UNS namespace identifier |
uns_namespace_rule_id |
no |
UNS namespace rule identifier |
uns_topic |
no |
UNS topic |
Total enabled variables: 115. Generated by postman-runner vars.
View this page as Markdown