Retrieve system status

GET 
/system/status

Get the current status of the system including hostname, uptime, load averages, memory, and disk usage.

Responses

200

A JSON object containing the system's status information.

application/json

Schema

Schema

hostname stringrequired

The hostname of the system.

uptime stringrequired

The uptime of the system.

load_average

object

required

The system load averages for 1, 5, and 15 minutes.

1min numberrequired

Load average for the last 1 minute.

5min numberrequired

Load average for the last 5 minutes.

15min numberrequired

Load average for the last 15 minutes.

memory

object

required

Memory usage information.

total integerrequired

Total memory in bytes.

free integerrequired

Free memory in bytes.

used integerrequired

Used memory in bytes.

disks

object[]

required

List of local disk usage information.

Array [

name stringrequired

Disk identifier, e.g., "/dev/sda1".

total integerrequired

Total disk space in bytes.

used integerrequired

Used disk space in bytes.

free integerrequired

Free disk space in bytes.

]

os_info

object

required

Operating system information.

distribution stringrequired

The name of the Linux distribution.

version stringrequired

The version of the Linux distribution.

Example (from schema)

{
  "hostname": "my-linux-server",
  "uptime": "0 days, 4 hours, 1 minute",
  "load_average": {
    "1min": 0.32,
    "5min": 0.28,
    "15min": 0.25
  },
  "memory": {
    "total": 8388608,
    "free": 2097152,
    "used": 4194304
  },
  "disks": [
    {
      "name": "/dev/sda1",
      "total": 500000000000,
      "used": 250000000000,
      "free": 250000000000
    }
  ],
  "os_info": {
    "distribution": "Ubuntu",
    "version": "20.04"
  }
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error retrieving system status.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...