System Info

Returns detailed information about the system including hardware, OS, JVM, and network configuration.

Request

Property	Value
Method	`GET`
URL	`/api/system/info`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/system/info" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Operating System

Parameter	Type	Description
`data.os.name`	string	Full OS name with kernel version
`data.os.arch`	string	System architecture
`data.os.version`	string	OS version

CPU Information

Parameter	Type	Description
`data.cpu.vendor`	string	CPU vendor identifier
`data.cpu.name`	string	Full CPU name
`data.cpu.model`	string	CPU model identifier
`data.cpu.pCoreCount`	integer	Number of physical cores
`data.cpu.lCoreCount`	integer	Number of logical cores (threads)
`data.cpu.baseFreq`	integer	Base frequency in MHz
`data.cpu.currFreq`	integer	Current frequency in MHz

Memory Information

Parameter	Type	Description
`data.memory.totalPhysicalMemory`	integer	Total physical memory in bytes
`data.memory.usedPhysicalMemory`	integer	Used physical memory in bytes
`data.memory.freePhysicalMemory`	integer	Free physical memory in bytes
`data.memory.totalSwapMemory`	integer	Total swap memory in bytes
`data.memory.usedSwapMemory`	integer	Used swap memory in bytes
`data.memory.initialHeapSize`	integer	JVM initial heap size in bytes
`data.memory.maxHeapSize`	integer	JVM maximum heap size in bytes

GPU Information

Parameter	Type	Description
`data.gpu`	array	List of detected GPUs
`data.gpu[].vendor`	string	GPU vendor (`"unknown"` if not detected)
`data.gpu[].name`	string	GPU name (`"unknown"` if not detected)
`data.gpu[].deviceId`	string	GPU device ID
`data.gpu[].vram`	string	Video memory (e.g., `"8 GB"`, `"0 B"`)

Network Interfaces

Parameter	Type	Description
`data.network`	array	List of network interfaces
`data.network[].name`	string	Interface name
`data.network[].mac`	string	MAC address
`data.network[].ipv4`	string\|null	IPv4 address (`null` if not detected)
`data.network[].ipv6`	string\|null	IPv6 address (`null` if not detected)

JVM Information

Parameter	Type	Description
`data.jvm.vendor`	string	JVM vendor name
`data.jvm.version`	string	JVM version

JVM Arguments

Parameter	Type	Description
`data.jvmArg.Xmx`	string	Maximum heap size
`data.jvmArg.Xms`	string	Initial heap size
`data.jvmArg.XX:`	string	Additional JVM options

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "os": {
      "name": "GNU/Linux Ubuntu 24.04.2 LTS (Noble Numbat) build 6.1.0-35-amd64",
      "arch": "amd64",
      "version": "24.04.2 LTS"
    },
    "cpu": {
      "vendor": "GenuineIntel",
      "name": "Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz",
      "model": "Intel64 Family 6 Model 79 Stepping 1",
      "pCoreCount": 12,
      "lCoreCount": 24,
      "baseFreq": 2100,
      "currFreq": 2099
    },
    "memory": {
      "totalPhysicalMemory": 67415789568,
      "usedPhysicalMemory": 7511109632,
      "freePhysicalMemory": 59904679936,
      "totalSwapMemory": 4000313344,
      "usedSwapMemory": 0,
      "initialHeapSize": 8589934592,
      "maxHeapSize": 25769803776
    },
    "gpu": [
      {
        "vendor": "unknown",
        "name": "unknown",
        "deviceId": "unknown",
        "vram": "0 B"
      }
    ],
    "network": [
      {
        "name": "network-name",
        "mac": "00:00:00:00:00:00",
        "ipv4": "0.0.0.0",
        "ipv6": "0000:0000:0000:0000:0000:0000:0000:0000"
      }
    ],
    "jvm": {
      "vendor": "Eclipse Adoptium",
      "version": "21.0.7"
    },
    "jvmArg": {
      "Xmx": "24g",
      "Xms": "8g",
      "XX:": "HeapDumpPath=/srv/storm/dumps/heapdump.hprof"
    }
  },
  "meta": {
    "executionTime": 65,
    "generatedAt": 1764239996267
  }
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.