Diagnostics API - Get | Pixotope Help Center

Service name: <MachineName>-Diagnostics (one per machine).

System

Gets for reading Diagnostics state published by this machine.

LOWPRIO_SystemInfo [GET]

LOWPRIO_SystemInfo

Returns the latest low-priority hardware statistics collected by Diagnostics. The same value is broadcast periodically to all subscribers.

No parameters — message is always {}.

Value

Value

OBJECT

System information grouped by CPU, GPU, memory, fans, and host network. Numeric and text metric values are wrapped as `{ "Value": value }`; unavailable rates are `null`. `Network.Interfaces` is sorted by stable interface ID. `Network.TCP` contains host-wide IPv4/IPv6 totals, not per-interface values. Health status is `unknown`, `ok`, `degraded`, or `congested`.

Example - Get current system information

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-Diagnostics",
  "RespondTo": "<Service>",
  "Name": "LOWPRIO_SystemInfo"
}

Response (you receive)

JSON

{
  "Type": "Update",
  "Source": "<MachineName>-Diagnostics",
  "Target": "<Service>",
  "Name": "LOWPRIO_SystemInfo"
}

JSON

{
  "Memory": {
    "Physical Memory Usage": {
      "Value": 42.1
    },
    "Virtual Memory Usage": {
      "Value": 12
    }
  },
  "Fans": {},
  "Network": {
    "Interfaces": [
      {
        "ID": {
          "Value": "00112233-4455-6677-8899-AABBCCDDEEFF"
        },
        "Name": {
          "Value": "Ethernet"
        },
        "Receive Mbps": {
          "Value": 120.5
        },
        "Transmit Mbps": {
          "Value": 40.2
        },
        "Health": {
          "Status": {
            "Value": "ok"
          }
        }
      }
    ],
    "TCP": {
      "Retransmits/s": {
        "Value": 0.2
      },
      "Retransmit %": {
        "Value": 0.04
      },
      "Health": {
        "Status": {
          "Value": "ok"
        }
      }
    },
    "Health": {
      "Status": {
        "Value": "ok"
      }
    }
  }
}

Try via Pixotope Gateway

No substitution needed for this request
Replace localhost with the machine IP address for remote calls

http://localhost:16208/gateway/latest/publish?Type=Get&Target=~LOCAL~-Diagnostics&Name=LOWPRIO_SystemInfo

Copy and paste into a browser to run - ⚠️ Executes immediately