Get System dashboard data

GET

/system/dashboard

curl --request GET \
  --url https://example.com/api/v1/system/dashboard \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Responses

200

Data returned

Media typeapplication/json

object

disks

List of disks

Array<object>

Disk statistics.

object

percent

Percentage of used memory

number

total

Total disk space (bytes)

integer

used

Used disk space (bytes)

integer

free

Free disk space (bytes)

integer

device

string

mountpoint

string

filesystem

string

load

Load averages (1 / 5 / 15 minutes)

Array<number>

cpuPercent

Current CPU usage in percent

object

user

Percentage of user CPU time

number

system

Percentage of system CPU time

number

io

Percentage of CPU time used for IO operations

number

interrupt

Percentage of CPU time used by interrupts

number

steal

Percentage of CPU time spent waiting for the hypervisor

number

idle

Idle CPU time

number

memory

RAM statistics

object

percent

Percent of used memory

number

total

Total memory (bytes)

integer

free

Unused memory (bytes)

integer

used

Memory used by applications (bytes)

integer

buffer

Memory used for buffers (bytes)

integer

cache

Memory used for cached data (bytes)

integer

available

Memory that is available for applications (bytes)

integer

swap

Swap statistics

object

percent

Percentage of used swap memory

number

total

Total swap memory (bytes)

integer

free

Available swap memory (bytes)

integer

used

Used swap memory (bytes)

integer

booted

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Example^generated

{
  "disks": [
    {
      "percent": 1,
      "total": 1,
      "used": 1,
      "free": 1,
      "device": "example",
      "mountpoint": "example",
      "filesystem": "example"
    }
  ],
  "load": [
    1
  ],
  "cpuPercent": {
    "user": 1,
    "system": 1,
    "io": 1,
    "interrupt": 1,
    "steal": 1,
    "idle": 1
  },
  "memory": {
    "percent": 1,
    "total": 1,
    "free": 1,
    "used": 1,
    "buffer": 1,
    "cache": 1,
    "available": 1
  },
  "swap": {
    "percent": 1,
    "total": 1,
    "free": 1,
    "used": 1
  },
  "booted": "example"
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}