---
title: "GET /v1/machine-info"
method: GET
path: "/v1/machine-info"
tags: ["MachineInfo"]
---

# GET /v1/machine-info

`GET /v1/machine-info`

## Request

- The document declares no server URL.
- Auth: none declared

## Response `200`

OK

- JadeTreeApiV1GetMachineInfoReply
  - `cpu` JadeTreeApiV1CPUInfo
    - `totalCores` integer
    - `totalHardwareThreads` integer
    - `processors` JadeTreeApiV1CPUProcessorItem[]
      - `id` integer
      - `vendor` string
      - `model` string
      - `totalCores` integer
      - `totalHardwareThreads` integer
      - `capabilities` string[]
      - `cores` JadeTreeApiV1CPUCoreItem[]
        - `id` integer
        - `hardwareThreads` integer
        - `logicalProcessors` integer[]
  - `memory` JadeTreeApiV1MemoryInfo
    - `totalPhysicalBytes` string
    - `totalUsableBytes` string
    - `supportedPageSizes` string[]
    - `usedBytes` string
    - `freeBytes` string
    - `sharedBytes` string
    - `buffCacheBytes` string
    - `availableBytes` string
    - `swapTotalBytes` string
    - `swapUsedBytes` string
    - `swapFreeBytes` string
  - `disks` JadeTreeApiV1DiskInfoItem[]
    - `name` string
    - `type` string
    - `sizeBytes` string
    - `vendor` string
    - `model` string
    - `serialNumber` string
    - `wwn` string
    - `mounts` JadeTreeApiV1DiskMountItem[]
      - `mountPoint` string
      - `fsType` string
      - `totalBytes` string
      - `usedBytes` string
      - `freeBytes` string
      - `freeRate` number, double
  - `network` JadeTreeApiV1NetworkInfo
    - `localIp` string
    - `outboundIp` string
    - `cidr` string
    - `dnsServers` string[]
    - `totalRxBytes` string
    - `totalTxBytes` string
    - `nics` string[]
  - `host` JadeTreeApiV1HostInfo
    - `hostName` string
    - `machineUuid` string: machineUuid is a best-effort host identifier (may collide across machines when cloned images share machine-id). Persisted rows use machineUuid + hostName + network.localIp as the composite unique key. On macOS it is sourced from `sysctl -n hw.uuid`. On Linux it is sourced from `/etc/machine-id` or `/var/lib/dbus/machine-id`.
  - `system` JadeTreeApiV1SystemInfo
    - `arch` string
    - `os` string
    - `version` string
    - `kernel` string
  - `uid` string: uid is the persisted machine row ID.
  - `agent` JadeTreeApiV1AgentInfo
    - `endpoint` string: endpoint is the backward-compatible merged endpoint string.
    - `version` string: version is the collector self-reported version.
    - `httpEndpoint` string: httpEndpoint is the collector self-reported HTTP endpoint.
    - `grpcEndpoint` string: grpcEndpoint is the collector self-reported gRPC endpoint.

## Changes

- **2026-04-09** `0d6b7b266755`: 2 info
  - added the optional property `agent` to the response with the `200` status
  - added the optional property `uid` to the response with the `200` status
- **2026-04-02** `b003ec301124`: 1 info
  - added the optional property `host/machineUuid` to the response with the `200` status
- **2026-04-01** `2bd26bb2fab4`: 1 info
  - endpoint added
- **2026-03-31** `78c6a8306f65`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/aide-family/apis/aide-family-jade-tree-api/changes/v1/machine-info/get.md)

---

[API](https://skmtc.dev/aide-family/apis/aide-family-jade-tree-api.md) - [All operations](https://skmtc.dev/aide-family/apis/aide-family-jade-tree-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aide-family/apis/aide-family-jade-tree-api/revisions/7c1198712e80?raw)