Litmus Edge 4.4.x - System: Support

DeviceHub Status

GET {{edgeUrl}}/devicehub/version

DeviceHub Status

Liveness / version probe for the DeviceHub service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/devicehub/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "2.18.15",
  "git": "bf1dbfcc3c"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "2.18.15",
    "git": "bf1dbfcc3c"
}

DeviceManagement Status

GET {{edgeUrl}}/dm/version

DeviceManagement Status

Liveness / version probe for the DeviceManagement service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/dm/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "5.9.16",
  "git": "7e892d15db"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "git": "7e892d15db",
    "version": "5.9.16"
}

Marketplace Status

GET {{edgeUrl}}/apps/version

Marketplace Status

Liveness / version probe for the Marketplace service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/apps/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.23.19",
  "git": "43e98fc37c"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.23.19",
    "git": "43e98fc37c"
}

Auth Status

GET {{edgeUrl}}/auth/v2/version

Auth Status

Liveness / version probe for the Auth service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/auth/v2/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "4.5.53",
  "git": "c20e59005e"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "git": "c20e59005e",
    "version": "4.5.53"
}

FTP Status

GET {{edgeUrl}}/ftp/version

FTP Status

Liveness / version probe for the FTP service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/ftp/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.4.4",
  "git": "f35f85fb14"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.4.4",
    "git": "f35f85fb14"
}

Integrations/CC Status

GET {{edgeUrl}}/cc/version

Integrations (CC) Status

Liveness / version probe for the Integrations (CC) service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/cc/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.15.5",
  "git": "3a1ecffeea"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.15.5",
    "git": "3a1ecffeea"
}

UI Status

GET {{edgeUrl}}/en-US/assets/version.json

UI Status

Liveness / version probe for the UI service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/en-US/assets/version.json

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "3.8.36",
  "git": "f7fb30967"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "3.8.36",
    "git": "f7fb30967"
}

OPC UA Status

GET {{edgeUrl}}/opcua/version

OPC UA Status

Liveness / version probe for the OPC UA service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/opcua/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.12.6",
  "git": "75b07950c7"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.12.6",
    "git": "75b07950c7"
}

Analytics Status

GET {{edgeUrl}}/analytics/v2/version

Analytics Status

Liveness / version probe for the Analytics service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/analytics/v2/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.17.5",
  "git": "04d3664a17"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.17.5",
    "git": "04d3664a17"
}

Flows Manager Status

GET {{edgeUrl}}/flows-manager/version

Flows Manager Status

Liveness / version probe for the Flows Manager service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/flows-manager/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.9.3",
  "git": "48e313fa2b"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.9.3",
    "git": "48e313fa2b"
}

Licensing Status

GET {{edgeUrl}}/lic/v2/version

Licensing Status

Liveness / version probe for the Licensing service. A 200 OK response means the service is up and reachable.

Endpoint

GET {{edgeUrl}}/lic/v2/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json

{
  "version": "1.6.26",
  "git": "f9a81c705d"
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.6.26",
    "git": "f9a81c705d"
}

Digital Twin Status

POST {{edgeUrl}}/digital-twins

Digital Twin Status

Liveness probe for the Digital Twins service. Unlike the other service probes in this folder, Digital Twins exposes its version as a GraphQL query rather than a REST endpoint.

Endpoint

POST {{edgeUrl}}/digital-twins
Content-Type: application/json

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Request body

query Version {
  Version { Git Version }
}

Response

{ "data": { "Version": { "Git": "20e4e53e40", "Version": "1.1.14" } } }

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Request Body

GraphQL Query

query Version {
    Version {
        Git
        Version
    }
}

Response

Status: 200 OK

{
    "data": {
        "Version": {
            "Git": "20e4e53e40",
            "Version": "1.1.14"
        }
    }
}

Generate and Download Support Bundle

GET {{edgeUrl}}/dm/supportbundle/generate

Generate and Download Support Bundle

Generates a support bundle (a tarball of logs, configuration, and diagnostics from every LE service) and streams it back as a download.

The generation step can take several minutes on busy devices. The response body begins streaming as the bundle is being assembled -- configure your HTTP client with a generous timeout (15+ minutes).

For ad-hoc generation without immediate download, the LE UI flow uses Get Support Bundle Generation Status to monitor progress.

Endpoint

GET {{edgeUrl}}/dm/supportbundle/generate

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/octet-stream (tar.gz). Use Postman's Send and Download to save to disk.

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Get Support Bundle Generation Status

GET {{edgeUrl}}/dm/supportbundle/status

Get Support Bundle Generation Status

Returns the progress of an in-flight support bundle generation.

Endpoint

GET {{edgeUrl}}/dm/supportbundle/status

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

{
  "msg": "writing the bundle",
  "status": "running",
  "step": 6,
  "steps": 6
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "msg": "writing the bundle",
    "status": "running",
    "step": 6,
    "steps": 6
}

Reset Support Bundle Creation

DELETE {{edgeUrl}}/dm/supportbundle

Reset Support Bundle Creation

Cancels any in-flight support bundle generation and clears its intermediate state. Use to recover from a hung generation.

Endpoint

DELETE {{edgeUrl}}/dm/supportbundle

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 204 No Content

List File Downloads

GET {{edgeUrl}}/downloads

List File Downloads

Returns the catalog of client-tool downloads the device hosts: DH Agent, Zerotouch, open-source license bundles, etc. Each entry includes architecture, OS, and version metadata.

Endpoint

GET {{edgeUrl}}/downloads

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

[
    {
        "arch": "x86",
        "description": "Edge Zerotouch",
        "filename": "edge-zerotouch",
        "itemname": "litmus-zerotouch",
        "os": "Linux",
        "size": 8535967,
        "version": "2.0.3"
    },
    {
        "arch": "x86",
        "description": "Edge DH Agent",
        "filename": "DeviceHubAgent_3.5.2_x86.exe",
        "itemname": "loopedge-dh-agent",
        "os": "Windows",
        "size": 31456389,
        "version": "3.5.2"
    },
    {
        "description": "Open Source Licenses",
        "filename": "opensource-licenses.tar.gz",
        "itemname": "opensource-licenses",
        "os": "Any",
        "size": 1572195
    }
]

Get File Download Details

GET {{edgeUrl}}/downloads/details/{name}

Get File Download Details

Returns the metadata for one named download plus its README content (markdown). Use this to render a per-tool detail page.

Endpoint

GET {{edgeUrl}}/downloads/details/{name}

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Path parameters

Response

{
  "metadata": { "desc": "...", "version": "...", "os": "Windows", "arch": "x86", "file": "...", "readme": "README.md" },
  "readme": "Edge DH Agent\n=============\n..."
}

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "metadata": {
        "arch": "x86",
        "desc": "Edge DH Agent",
        "file": "DeviceHubAgent_3.5.2_x86.exe",
        "os": "Windows",
        "readme": "README.md",
        "version": "3.5.2"
    },
    "readme": "Edge DH Agent\n=============\n\nEdge DH Agent is a proxy between OPC DA server and Edge system. It helps users\nto search for available servers and extract list of tags from a server. A user\ncan then select tags which need to be added and send them to Edge device.\n\nThere are options to export tags from the OPC DA server to a csv file or send\nthem directly to an Edge device. Status of the tags is checked periodically\nand multiple servers can be connected at the same time.\n"
}

NATS Status

GET {{edgeUrl}}/support/nats/status

Version and uptime of the NATS message broker underpinning inter-service messaging on the device.

uptime is a duration string such as 5d1h16m52s. A short uptime against a long device uptime means the broker restarted, which is worth knowing when chasing dropped messages between services.

Response

Status: 200 OK

{"version":"2.12.2","uptime":"5d1h18m53s"}

Access Service Status

GET {{edgeUrl}}/access/version

Access Service Status

Version and build commit of the access service, which handles message-broker authentication and the NATS proxy.

Endpoint

GET {{edgeUrl}}/access/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json: {"version": "...", "git": "..."}. Completes the per-service version probes in this folder.

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "1.8.3",
    "git": "e61f83371b"
}

Network Utility Status

GET {{edgeUrl}}/networkutil/version

Network Utility Status

Version and build commit of the network utility service, which backs asset discovery and the network scanning endpoints.

Endpoint

GET {{edgeUrl}}/networkutil/version

Authentication

HTTP Basic Auth. Username is your API token, password is empty. Tokens are managed under System > Access Control > Tokens.

Response

200 OK -- application/json: {"version": "...", "git": "..."}. Completes the per-service version probes in this folder.

Errors

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Response

Status: 200 OK

{
    "version": "0.12.0",
    "git": "c4723732cd"
}

Digital Twins Health Check

POST {{edgeUrl}}/digital-twins

Digital Twins Health Check

Asks the Digital Twins service whether it is healthy. The web UI's System page calls it next to the version check in Digital Twin Status.

Endpoint

POST {{edgeUrl}}/digital-twins

Authentication

HTTP Basic Auth. Username is your API token, password is empty. The same token is valid across /devicehub/v2, /analytics/v2, /cc, /opcua, and the other LE services.

Query

query Healthz {
  Healthz
}

No variables.

Response

data.Healthz is a Boolean!, true when the service is healthy. A service that is down does not answer at all (the gateway returns a 5xx).

Errors

GraphQL endpoints return 200 OK even on logical errors. Inspect the errors array in the response body:

{ "errors": [ { "message": "...", "path": ["..."], "extensions": { "code": "..." } } ] }

A non-200 HTTP response means DeviceHub itself is unreachable. See Dashboard > DeviceHub Status.

TLS note: edge devices use a self-signed certificate by default. Either install the device CA in your client trust store or disable certificate verification when calling this endpoint directly.

Request Body

GraphQL Query

query Healthz {
  Healthz
}

Response

Status: 200 OK

{
    "data": {
        "Healthz": true
    }
}