Read server data

get/api/v1/metrics

Response

Example response

{
  "data": {
    "cpu": {
      "physical_core": 4,
      "logical_core": 8,
      "frequency": 2500,
      "free_percent": 0.5,
      "usage_percent": 0.5
    },
    "memory": {
      "total_bytes": 1351533568,
      "available_bytes": 351533568,
      "used_bytes": 1000000000,
      "usage_percent": 0.2601
    },
    "disk": [
      {
        "device": "/dev/sda1",
        "mountpoint": "/home",
        "total_bytes": 1099511627776,
        "free_bytes": 549755813888,
        "used_bytes": 549755813888,
        "usage_percent": 50,
        "total_inodes": 1000000,
        "free_inodes": 500000,
        "used_inodes": 500000,
        "inodes_usage_percent": 50,
        "read_bytes": 1024000,
        "write_bytes": 512000,
        "read_time": 1000,
        "write_time": 500
      }
    ],
    "host": {
      "os": "linux",
      "platform": "debian",
      "kernel_version": "5.4.0-42-generic"
    },
    "net": [
      {
        "name": "eth0",
        "bytes_sent": 1024,
        "bytes_recv": 2048,
        "packets_sent": 100,
        "packets_recv": 200
      }
    ]
  },
  "errors": [
    {
      "metric": [
        "cpu.temperature"
      ]
    }
  ]
}

Changes

Changed in 5 of the 8 revisions of this API.727

Jul 17, 202676f1b333af182See the full diff
- ○
  added the optional property data/disk/items/mountpoint to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/disk/items/mountpoint to the response with the 207 status
  response-optional-property-added
Dec 6, 2025577d4aa2949c22See the full diff
- ●
  removed the optional property errors/items/error from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property errors/items/error from the response with the 207 status
  response-optional-property-removed
- ○
  added the optional property errors/items/err to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property errors/items/err to the response with the 207 status
  response-optional-property-added
Jul 17, 2025a5791047c7e462See the full diff
- ▲
  the response property data/cpu/temperature became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property data/cpu/temperature became nullable for the status 207
  response-property-became-nullable
- ▲
  the data/cpu/temperature response's property type/format changed from number/ to array/ for status 200
  response-property-type-changed
- ▲
  the data/cpu/temperature response's property type/format changed from number/ to array/ for status 207
  response-property-type-changed
- ▲
  the errors/items/metric response's property type/format changed from string/ to array/ for status 200
  response-property-type-changed
- ▲
  the errors/items/metric response's property type/format changed from string/ to array/ for status 207
  response-property-type-changed
- ○
  the endpoint scheme security type AND scheme AND bearerFormat was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 4, 202569b4529f7c411See the full diff
- ○
  endpoint added
  endpoint-added
Dec 16, 20240e2250f78cf01See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history