Restful/JSON API documentation

This documentation describes the Glances API version 4 (Restful/JSON) interface.

An OpenAPI specification file is available at: https://raw.githubusercontent.com/nicolargo/glances/refs/heads/develop/docs/api/openapi.json

Run the Glances API server

The Glances Restful/API server could be ran using the following command line:

# glances -w --disable-webui

It is also ran automatically when Glances is started in Web server mode (-w).

If you want to enable the Glances Central Browser, use:

# glances -w --browser --disable-webui

API URL

The default root API URL is http://localhost:61208/api/4.

The bind address and port could be changed using the --bind and --port command line options.

It is also possible to define an URL prefix using the url_prefix option from the [outputs] section of the Glances configuration file.

Note: The url_prefix should always end with a slash (/).

For example:

[outputs]
url_prefix = /glances/

will change the root API URL to http://localhost:61208/glances/api/4 and the Web UI URL to http://localhost:61208/glances/

API documentation URL

The API documentation is embeded in the server and available at the following URL: http://localhost:61208/docs#/.

Authentication

Glances API supports both HTTP Basic authentication and JWT (JSON Web Token) Bearer authentication.

To enable authentication, start Glances with the --password option.

To generate a new login/password pair, use the following command:

glances -w --username
> Enter new username: foo
> Enter new password: ********
> Confirm new password: ********
> User 'username' created/updated successfully.

To reuse an existing login/password pair, start Glances with the -u <user> option:

glances -w -u foo

JWT Token Authentication

JWT authentication requires the python-jose library to be installed.

Step 1: Get a JWT Token

Request a token by sending your credentials to the token endpoint:

curl -X POST http://localhost:61208/api/4/token \
  -H "Content-Type: application/json" \
  -d '{"username": "your_username", "password": "your_password"}'

This will return a response like:

{
  "access_token": "...",
  "token_type": "bearer",
  "expires_in": 3600
}

Step 2: Use the Token

Use the token in the Authorization header with Bearer authentication:

# Store the token in a variable
TOKEN="your_access_token_here"

# Access a protected endpoint
curl -H "Authorization: Bearer $TOKEN" \
  http://localhost:61208/api/4/cpu

Complete Example:

# Get token and extract access_token
TOKEN=$(curl -s -X POST http://localhost:61208/api/4/token \
  -H "Content-Type: application/json" \
  -d '{"username": "glances", "password": "mypassword"}' \
  | grep -o '"access_token":"[^"]*"' \
  | cut -d'"' -f4)

# Use the token to get CPU stats
curl -H "Authorization: Bearer $TOKEN" \
  http://localhost:61208/api/4/cpu

Configuration:

You can configure JWT settings in the Glances configuration file:

[outputs]
# JWT secret key (if not set, a random key will be generated)
jwt_secret_key = your-secret-key-here
# JWT token expiration in minutes (default: 60)
jwt_expire_minutes = 60

Note: The token endpoint (/api/4/token) does not require authentication. Protected endpoints support both Bearer token and Basic Auth authentication methods.

Security

By default, Glances web server runs without authentication and binds to all network interfaces (0.0.0.0). This means any client that can reach the server on the network can access the full REST API, including sensitive system information such as process command-lines, which may contain credentials (passwords, API keys, tokens passed as arguments).

This default is intentional for ease of use on private, trusted networks (home labs, local machines, internal infrastructure). However, if your Glances instance is reachable from untrusted networks, you should take the following precautions:

Enable authentication by starting Glances with the --password option:

glances -w --password

Bind to localhost only if remote access is not needed:

glances -w --bind 127.0.0.1

Enable DNS rebinding protection by setting webui_allowed_hosts in glances.conf. This restricts the HTTP Host header values accepted by the web server. Without this setting, a DNS rebinding attack could allow an untrusted web page to read the REST API from a victim’s browser on the same network, even without direct network access to the Glances instance.

[outputs]
# Comma-separated list of allowed hostnames/IPs.
# Wildcards are supported (e.g. *.example.com).
webui_allowed_hosts=localhost,127.0.0.1,myserver.example.com

When webui_allowed_hosts is set, requests with a Host header not in the list are rejected with 400 Bad Request. When absent or commented out (the default), no host filtering is applied.

Use a reverse proxy (nginx, Caddy, Apache) with TLS and authentication for any public-facing or semi-public deployment. This is the recommended approach for production environments.

# Example: restrict bind to localhost, access via reverse proxy
# In glances.conf:
[outputs]
# Bind to localhost, let the reverse proxy handle external access
# then configure your reverse proxy to forward to 127.0.0.1:61208
webui_allowed_hosts=localhost,127.0.0.1

Note

The bind address (0.0.0.0 by default) controls which network interfaces the server listens on, but it is not a security boundary. For deployments on non-loopback interfaces, always set webui_allowed_hosts and consider enabling authentication.

CORS (Cross-Origin Resource Sharing) controls which external websites can make requests to the Glances API from a browser. By default, Glances allows requests from any origin (cors_origins=*) but does not allow credentials (cors_credentials=False). This means cross-origin requests work for unauthenticated API access, but browsers will not send stored credentials (e.g. Basic Auth) to the API from a third-party page.

If you need credentialed cross-origin access (e.g. a separate dashboard application that authenticates to Glances), you must configure explicit origins — the wildcard * combined with credentials is insecure and will be automatically rejected:

[outputs]
cors_origins=https://my-dashboard.internal.example.com
cors_credentials=True

Warning

Setting cors_credentials=True with cors_origins=* is not allowed. Glances will automatically disable credentials and log a warning if this combination is detected. This prevents a class of cross-site data theft attacks where any website could read your monitoring data.

When Glances is started without authentication or without host filtering, warning messages are displayed at startup to remind you of the risks.

WebUI refresh

It is possible to change the Web UI refresh rate (default is 2 seconds) using the following option in the URL: http://localhost:61208/?refresh=5

GET API status

This entry point should be used to check the API status. It will the Glances version and a 200 return code if everything is OK.

Get the Rest API status:

# curl -I http://localhost:61208/api/4/status
"HTTP/1.0 200 OK"

GET plugins list

Get the plugins list:

# curl http://localhost:61208/api/4/pluginslist
["alert",
 "amps",
 "cloud",
 "connections",
 "containers",
 "core",
 "cpu",
 "diskio",
 "folders",
 "fs",
 "gpu",
 "help",
 "ip",
 "irq",
 "load",
 "mem",
 "memswap",
 "mpp",
 "network",
 "now",
 "npu",
 "percpu",
 "ports",
 "processcount",
 "processlist",
 "programlist",
 "psutilversion",
 "quicklook",
 "raid",
 "sensors",
 "smart",
 "system",
 "uptime",
 "version",
 "vms",
 "wifi"]

GET alert

Get plugin stats:

# curl http://localhost:61208/api/4/alert
[]

Fields descriptions:

begin: Begin timestamp of the event (unit is timestamp)
end: End timestamp of the event (or -1 if ongoing) (unit is timestamp)
state: State of the event (WARNING|CRITICAL) (unit is string)
type: Type of the event (CPU|LOAD|MEM) (unit is string)
max: Maximum value during the event period (unit is float)
avg: Average value during the event period (unit is float)
min: Minimum value during the event period (unit is float)
sum: Sum of the values during the event period (unit is float)
count: Number of values during the event period (unit is int)
top: Top 3 processes name during the event period (unit is list)
desc: Description of the event (unit is string)
sort: Sort key of the top processes (unit is string)
global_msg: Global alert message (unit is string)

POST clear events

Clear all alarms from the list:

# curl -H "Content-Type: application/json" -X POST http://localhost:61208/api/4/events/clear/all

Clear warning alarms from the list:

# curl -H "Content-Type: application/json" -X POST http://localhost:61208/api/4/events/clear/warning

GET amps

Get plugin stats:

# curl http://localhost:61208/api/4/amps
[{"count": 0,
  "countmax": None,
  "countmin": 1.0,
  "key": "name",
  "name": "Dropbox",
  "refresh": 3.0,
  "regex": True,
  "result": None,
  "timer": 0.2925989627838135},
 {"count": 0,
  "countmax": 20.0,
  "countmin": None,
  "key": "name",
  "name": "Python",
  "refresh": 3.0,
  "regex": True,
  "result": None,
  "timer": 0.292543888092041}]

Fields descriptions:

name: AMP name (unit is None)
result: AMP result (a string) (unit is None)
refresh: AMP refresh interval (unit is second)
timer: Time until next refresh (unit is second)
count: Number of matching processes (unit is number)
countmin: Minimum number of matching processes (unit is number)
countmax: Maximum number of matching processes (unit is number)

Get a specific field:

# curl http://localhost:61208/api/4/amps/name
{"name": ["Dropbox", "Python", "Conntrack", "Nginx", "Systemd", "SystemV"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/amps/name/value/Dropbox
{"Dropbox": [{"count": 0,
              "countmax": None,
              "countmin": 1.0,
              "key": "name",
              "name": "Dropbox",
              "refresh": 3.0,
              "regex": True,
              "result": None,
              "timer": 0.2925989627838135}]}

GET cloud

Get plugin stats:

# curl http://localhost:61208/api/4/cloud
{}

GET connections

Get plugin stats:

# curl http://localhost:61208/api/4/connections
{"net_connections_enabled": True, "nf_conntrack_enabled": True}

Fields descriptions:

LISTEN: Number of TCP connections in LISTEN state (unit is number)
ESTABLISHED: Number of TCP connections in ESTABLISHED state (unit is number)
SYN_SENT: Number of TCP connections in SYN_SENT state (unit is number)
SYN_RECV: Number of TCP connections in SYN_RECV state (unit is number)
initiated: Number of TCP connections initiated (unit is number)
terminated: Number of TCP connections terminated (unit is number)
nf_conntrack_count: Number of tracked connections (unit is number)
nf_conntrack_max: Maximum number of tracked connections (unit is number)
nf_conntrack_percent: Percentage of tracked connections (unit is percent)

Get a specific field:

# curl http://localhost:61208/api/4/connections/net_connections_enabled
{"net_connections_enabled": True}

GET containers

Get plugin stats:

# curl http://localhost:61208/api/4/containers
[]

Fields descriptions:

name: Container name (unit is None)
id: Container ID (unit is None)
image: Container image (unit is None)
status: Container status (unit is None)
created: Container creation date (unit is None)
command: Container command (unit is None)
cpu_percent: Container CPU consumption (unit is percent)
memory_inactive_file: Container memory inactive file (unit is byte)
memory_limit: Container memory limit (unit is byte)
memory_usage: Container memory usage (unit is byte)
io_rx: Container IO bytes read rate (unit is bytepersecond)
io_wx: Container IO bytes write rate (unit is bytepersecond)
network_rx: Container network RX bitrate (unit is bitpersecond)
network_tx: Container network TX bitrate (unit is bitpersecond)
ports: Container ports (unit is None)
uptime: Container uptime (unit is None)
engine: Container engine (Docker, Podman, and LXD are currently supported) (unit is None)
pod_name: Pod name (only with Podman) (unit is None)
pod_id: Pod ID (only with Podman) (unit is None)

GET core

Get plugin stats:

# curl http://localhost:61208/api/4/core
{"log": 16, "phys": 10}

Fields descriptions:

phys: Number of physical cores (hyper thread CPUs are excluded) (unit is number)
log: Number of logical CPU cores. A logical CPU is the number of physical cores multiplied by the number of threads that can run on each core (unit is number)

Get a specific field:

# curl http://localhost:61208/api/4/core/phys
{"phys": 10}

GET cpu

Get plugin stats:

# curl http://localhost:61208/api/4/cpu
{"cpucore": 16,
 "ctx_switches": 75045721,
 "guest": 0.0,
 "idle": 93.6,
 "interrupts": 52136871,
 "iowait": 0.2,
 "irq": 0.0,
 "nice": 0.0,
 "soft_interrupts": 25192508,
 "steal": 0.0,
 "syscalls": 0,
 "system": 2.6,
 "total": 5.8,
 "user": 3.6}

Fields descriptions:

total: Sum of all CPU percentages (except idle) (unit is percent)
system: Percent time spent in kernel space. System CPU time is the time spent running code in the Operating System kernel (unit is percent)
user: CPU percent time spent in user space. User CPU time is the time spent on the processor running your program’s code (or code in libraries) (unit is percent)
iowait: (Linux): percent time spent by the CPU waiting for I/O operations to complete (unit is percent)
dpc: (Windows): time spent servicing deferred procedure calls (DPCs) (unit is percent)
idle: percent of CPU used by any program. Every program or task that runs on a computer system occupies a certain amount of processing time on the CPU. If the CPU has completed all tasks it is idle (unit is percent)
irq: (Linux and BSD): percent time spent servicing/handling hardware/software interrupts. Time servicing interrupts (hardware + software) (unit is percent)
nice: (Unix): percent time occupied by user level processes with a positive nice value. The time the CPU has spent running users’ processes that have been niced (unit is percent)
steal: (Linux): percentage of time a virtual CPU waits for a real CPU while the hypervisor is servicing another virtual processor (unit is percent)
guest: (Linux): time spent running a virtual CPU for guest operating systems under the control of the Linux kernel (unit is percent)
ctx_switches: number of context switches (voluntary + involuntary) per second. A context switch is a procedure that a computer’s CPU (central processing unit) follows to change from one task (or process) to another while ensuring that the tasks do not conflict (unit is number)
ctx_switches_rate_per_sec: number of context switches (voluntary + involuntary) per second. A context switch is a procedure that a computer’s CPU (central processing unit) follows to change from one task (or process) to another while ensuring that the tasks do not conflict per second (unit is number per second)
ctx_switches_gauge: number of context switches (voluntary + involuntary) per second. A context switch is a procedure that a computer’s CPU (central processing unit) follows to change from one task (or process) to another while ensuring that the tasks do not conflict (cumulative) (unit is number)
interrupts: number of interrupts per second (unit is number)
interrupts_rate_per_sec: number of interrupts per second per second (unit is number per second)
interrupts_gauge: number of interrupts per second (cumulative) (unit is number)
soft_interrupts: number of software interrupts per second. Always set to 0 on Windows and SunOS (unit is number)
soft_interrupts_rate_per_sec: number of software interrupts per second. Always set to 0 on Windows and SunOS per second (unit is number per second)
soft_interrupts_gauge: number of software interrupts per second. Always set to 0 on Windows and SunOS (cumulative) (unit is number)
syscalls: number of system calls per second. Always 0 on Linux OS (unit is number)
syscalls_rate_per_sec: number of system calls per second. Always 0 on Linux OS per second (unit is number per second)
syscalls_gauge: number of system calls per second. Always 0 on Linux OS (cumulative) (unit is number)
cpucore: Total number of CPU core (unit is number)
time_since_update: Number of seconds since last update (unit is seconds)
total_min: Minimum total observed since Glances startup (unit is percent)
total_max: Maximum total observed since Glances startup (unit is percent)
total_mean: Mean (average) total computed from the history (unit is percent)
time_since_update: Number of seconds since last update (unit is seconds)

Get a specific field:

# curl http://localhost:61208/api/4/cpu/total
{"total": 5.8}

GET diskio

Get plugin stats:

# curl http://localhost:61208/api/4/diskio
[{"disk_name": "nvme0n1",
  "key": "disk_name",
  "read_bytes": 10320042496,
  "read_count": 536983,
  "read_latency": 0,
  "read_time": 73159,
  "write_bytes": 15555986432,
  "write_count": 662736,
  "write_latency": 0,
  "write_time": 883979},
 {"disk_name": "nvme0n1p1",
  "key": "disk_name",
  "read_bytes": 7537664,
  "read_count": 619,
  "read_latency": 0,
  "read_time": 219,
  "write_bytes": 5120,
  "write_count": 3,
  "write_latency": 0,
  "write_time": 0}]

Fields descriptions:

disk_name: Disk name (unit is None)
read_count: Number of reads (unit is number)
read_count_rate_per_sec: Number of reads per second (unit is number per second)
read_count_gauge: Number of reads (cumulative) (unit is number)
write_count: Number of writes (unit is number)
write_count_rate_per_sec: Number of writes per second (unit is number per second)
write_count_gauge: Number of writes (cumulative) (unit is number)
read_bytes: Number of bytes read (unit is byte)
read_bytes_rate_per_sec: Number of bytes read per second (unit is byte per second)
read_bytes_gauge: Number of bytes read (cumulative) (unit is byte)
write_bytes: Number of bytes written (unit is byte)
write_bytes_rate_per_sec: Number of bytes written per second (unit is byte per second)
write_bytes_gauge: Number of bytes written (cumulative) (unit is byte)
read_time: Time spent reading (unit is millisecond)
read_time_rate_per_sec: Time spent reading per second (unit is millisecond per second)
read_time_gauge: Time spent reading (cumulative) (unit is millisecond)
write_time: Time spent writing (unit is millisecond)
write_time_rate_per_sec: Time spent writing per second (unit is millisecond per second)
write_time_gauge: Time spent writing (cumulative) (unit is millisecond)
read_latency: Mean time spent reading per operation (unit is millisecond)
write_latency: Mean time spent writing per operation (unit is millisecond)
time_since_update: Number of seconds since last update (unit is seconds)

Get a specific field:

# curl http://localhost:61208/api/4/diskio/disk_name
{"disk_name": ["nvme0n1",
               "nvme0n1p1",
               "nvme0n1p2",
               "nvme0n1p3",
               "dm-0",
               "dm-1"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/diskio/disk_name/value/nvme0n1
{"nvme0n1": [{"disk_name": "nvme0n1",
              "key": "disk_name",
              "read_bytes": 10320042496,
              "read_count": 536983,
              "read_latency": 0,
              "read_time": 73159,
              "write_bytes": 15555986432,
              "write_count": 662736,
              "write_latency": 0,
              "write_time": 883979}]}

GET folders

Get plugin stats:

# curl http://localhost:61208/api/4/folders
[]

Fields descriptions:

path: Absolute path (unit is None)
size: Folder size in bytes (unit is byte)
refresh: Refresh interval in seconds (unit is second)
errno: Return code when retrieving folder size (0 is no error) (unit is number)
careful: Careful threshold in MB (unit is megabyte)
warning: Warning threshold in MB (unit is megabyte)
critical: Critical threshold in MB (unit is megabyte)

GET fs

Get plugin stats:

# curl http://localhost:61208/api/4/fs
[{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
  "free": 543403073536,
  "fs_type": "ext4",
  "key": "mnt_point",
  "mnt_point": "/",
  "options": "rw,relatime",
  "percent": 43.0,
  "size": 1003736440832,
  "used": 409270861824},
 {"device_name": "zsfpool",
  "free": 41680896,
  "fs_type": "zfs",
  "key": "mnt_point",
  "mnt_point": "/zsfpool",
  "options": "rw,relatime,xattr,noacl,casesensitive",
  "percent": 0.3,
  "size": 41811968,
  "used": 131072}]

Fields descriptions:

device_name: Device name (unit is None)
fs_type: File system type (unit is None)
mnt_point: Mount point (unit is None)
options: Mount options (unit is None)
size: Total size (unit is byte)
used: Used size (unit is byte)
free: Free size (unit is byte)
percent: File system usage in percent (unit is percent)

Get a specific field:

# curl http://localhost:61208/api/4/fs/mnt_point
{"mnt_point": ["/", "/zsfpool"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/fs/mnt_point/value//
{"/": [{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
        "free": 543403073536,
        "fs_type": "ext4",
        "key": "mnt_point",
        "mnt_point": "/",
        "options": "rw,relatime",
        "percent": 43.0,
        "size": 1003736440832,
        "used": 409270861824}]}

GET gpu

Get plugin stats:

# curl http://localhost:61208/api/4/gpu
[{"fan_speed": None,
  "gpu_id": "intel0",
  "key": "gpu_id",
  "mem": None,
  "name": "UHD Graphics",
  "proc": 0,
  "temperature": None},
 {"fan_speed": None,
  "gpu_id": "intel1",
  "key": "gpu_id",
  "mem": None,
  "name": "Arc A370M",
  "proc": 0,
  "temperature": None}]

Fields descriptions:

gpu_id: GPU identification (unit is None)
name: GPU name (unit is None)
mem: Memory consumption (unit is percent)
proc: GPU processor consumption (unit is percent)
temperature: GPU temperature (unit is celsius)
fan_speed: GPU fan speed (unit is roundperminute)

Get a specific field:

# curl http://localhost:61208/api/4/gpu/gpu_id
{"gpu_id": ["intel0", "intel1"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/gpu/gpu_id/value/intel0
{"intel0": [{"fan_speed": None,
             "gpu_id": "intel0",
             "key": "gpu_id",
             "mem": None,
             "name": "UHD Graphics",
             "proc": 0,
             "temperature": None}]}

GET help

Get plugin stats:

# curl http://localhost:61208/api/4/help
None

GET ip

Get plugin stats:

# curl http://localhost:61208/api/4/ip
{"address": "192.168.1.26", "mask": "255.255.255.0", "mask_cidr": 24}

Fields descriptions:

address: Private IP address (unit is None)
mask: Private IP mask (unit is None)
mask_cidr: Private IP mask in CIDR format (unit is number)
gateway: Private IP gateway (unit is None)
public_address: Public IP address (unit is None)
public_info_human: Public IP information (unit is None)

Get a specific field:

# curl http://localhost:61208/api/4/ip/address
{"address": "192.168.1.26"}

GET irq

Get plugin stats:

# curl http://localhost:61208/api/4/irq
[]

Fields descriptions:

irq_line: IRQ line name (unit is None)
irq_rate: IRQ rate per second (unit is numberpersecond)

GET load

Get plugin stats:

# curl http://localhost:61208/api/4/load
{"cpucore": 16,
 "min1": 0.42626953125,
 "min15": 0.68310546875,
 "min5": 0.61083984375}

Fields descriptions:

min1: Average sum of the number of processes waiting in the run-queue plus the number currently executing over 1 minute (unit is float)
min5: Average sum of the number of processes waiting in the run-queue plus the number currently executing over 5 minutes (unit is float)
min15: Average sum of the number of processes waiting in the run-queue plus the number currently executing over 15 minutes (unit is float)
cpucore: Total number of CPU core (unit is number)
min1_min: Minimum min1 observed since Glances startup (unit is float)
min1_max: Maximum min1 observed since Glances startup (unit is float)
min1_mean: Mean (average) min1 computed from the history (unit is float)

Get a specific field:

# curl http://localhost:61208/api/4/load/min1
{"min1": 0.42626953125}

GET mem

Get plugin stats:

# curl http://localhost:61208/api/4/mem
{"active": 5232918528,
 "available": 5960223720,
 "buffers": 269709312,
 "cached": 6829525864,
 "free": 928632832,
 "inactive": 7582957568,
 "percent": 63.7,
 "percent_max": 63.7,
 "percent_mean": 63.7,
 "percent_min": 63.7,
 "shared": 1811132416,
 "total": 16421220352,
 "used": 10460996632}

Fields descriptions:

total: Total physical memory available (unit is bytes)
available: The actual amount of available memory that can be given instantly to processes that request more memory in bytes; this is calculated by summing different memory values depending on the platform (e.g. free + buffers + cached on Linux) and it is supposed to be used to monitor actual memory usage in a cross platform fashion (unit is bytes)
percent: The percentage usage calculated as (total - available) / total * 100 (unit is percent)
used: Memory used, calculated differently depending on the platform and designed for informational purposes only (unit is bytes)
free: Memory not being used at all (zeroed) that is readily available; note that this doesn’t reflect the actual memory available (use ‘available’ instead) (unit is bytes)
active: (UNIX): memory currently in use or very recently used, and so it is in RAM (unit is bytes)
inactive: (UNIX): memory that is marked as not used (unit is bytes)
buffers: (Linux, BSD): cache for things like file system metadata (unit is bytes)
cached: (Linux, BSD): cache for various things (including ZFS cache) (unit is bytes)
wired: (BSD, macOS): memory that is marked to always stay in RAM. It is never moved to disk (unit is bytes)
shared: (BSD): memory that may be simultaneously accessed by multiple processes (unit is bytes)
percent_min: Minimum percent observed since Glances startup (unit is percent)
percent_max: Maximum percent observed since Glances startup (unit is percent)
percent_mean: Mean (average) percent computed from the history (unit is percent)

Get a specific field:

# curl http://localhost:61208/api/4/mem/total
{"total": 16421220352}

GET memswap

Get plugin stats:

# curl http://localhost:61208/api/4/memswap
{"free": 3873906688,
 "percent": 9.8,
 "sin": 14299136,
 "sout": 404652032,
 "time_since_update": 1,
 "total": 4294963200,
 "used": 421056512}

Fields descriptions:

total: Total swap memory (unit is bytes)
used: Used swap memory (unit is bytes)
free: Free swap memory (unit is bytes)
percent: Used swap memory in percentage (unit is percent)
sin: The number of bytes the system has swapped in from disk (cumulative) (unit is bytes)
sout: The number of bytes the system has swapped out from disk (cumulative) (unit is bytes)
time_since_update: Number of seconds since last update (unit is seconds)

Get a specific field:

# curl http://localhost:61208/api/4/memswap/total
{"total": 4294963200}

GET mpp

Get plugin stats:

# curl http://localhost:61208/api/4/mpp
[]

Fields descriptions:

engine_id: Engine identification (unit is None)
name: Engine name (unit is None)
type: Engine type (encoder/decoder/jpeg) (unit is None)
load: Engine load (unit is percent)
utilization: Engine utilization (unit is percent)
sessions: Number of active sessions (unit is None)

GET network

Get plugin stats:

# curl http://localhost:61208/api/4/network
[{"alias": None,
  "bytes_all": 0,
  "bytes_all_gauge": 2240110069,
  "bytes_all_rate_per_sec": 0,
  "bytes_recv": 0,
  "bytes_recv_gauge": 2126990666,
  "bytes_recv_rate_per_sec": 0,
  "bytes_sent": 0,
  "bytes_sent_gauge": 113119403,
  "bytes_sent_rate_per_sec": 0,
  "interface_name": "wlp0s20f3",
  "key": "interface_name",
  "speed": 0,
  "time_since_update": 0.2988929748535156}]

Fields descriptions:

interface_name: Interface name (unit is None)
alias: Interface alias name (optional) (unit is None)
bytes_recv: Number of bytes received (unit is byte)
bytes_recv_rate_per_sec: Number of bytes received per second (unit is byte per second)
bytes_recv_gauge: Number of bytes received (cumulative) (unit is byte)
bytes_sent: Number of bytes sent (unit is byte)
bytes_sent_rate_per_sec: Number of bytes sent per second (unit is byte per second)
bytes_sent_gauge: Number of bytes sent (cumulative) (unit is byte)
bytes_all: Number of bytes received and sent (unit is byte)
bytes_all_rate_per_sec: Number of bytes received and sent per second (unit is byte per second)
bytes_all_gauge: Number of bytes received and sent (cumulative) (unit is byte)
speed: Maximum interface speed (in bit per second). Can return 0 on some operating-system (unit is bitpersecond)
is_up: Is the interface up ? (unit is bool)
time_since_update: Number of seconds since last update (unit is seconds)

Get a specific field:

# curl http://localhost:61208/api/4/network/interface_name
{"interface_name": ["wlp0s20f3"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/network/interface_name/value/wlp0s20f3
{"wlp0s20f3": [{"alias": None,
                "bytes_all": 0,
                "bytes_all_gauge": 2240110069,
                "bytes_all_rate_per_sec": 0,
                "bytes_recv": 0,
                "bytes_recv_gauge": 2126990666,
                "bytes_recv_rate_per_sec": 0,
                "bytes_sent": 0,
                "bytes_sent_gauge": 113119403,
                "bytes_sent_rate_per_sec": 0,
                "interface_name": "wlp0s20f3",
                "key": "interface_name",
                "speed": 0,
                "time_since_update": 0.2988929748535156}]}

GET now

Get plugin stats:

# curl http://localhost:61208/api/4/now
{"custom": "2026-04-19 09:37:39 CEST", "iso": "2026-04-19T09:37:39+02:00"}

Fields descriptions:

custom: Current date in custom format (unit is None)
iso: Current date in ISO 8601 format (unit is None)

Get a specific field:

# curl http://localhost:61208/api/4/now/iso
{"iso": "2026-04-19T09:37:39+02:00"}

GET npu

Get plugin stats:

# curl http://localhost:61208/api/4/npu
[]

Fields descriptions:

npu_id: NPU identification (unit is None)
name: NPU name (unit is None)
load: NPU load (unit is percent)
freq: NPU frequency (unit is percent)
freq_current: NPU current frequency (unit is hertz)
freq_max: NPU maximum frequency (unit is hertz)
mem: Memory consumption (unit is percent)
memory_used: Memory used (unit is byte)
memory_total: Memory total (unit is byte)
temperature: NPU temperature (unit is celsius)
power: NPU power consumption (unit is watt)

GET percpu

Get plugin stats:

# curl http://localhost:61208/api/4/percpu
[{"cpu_number": 0,
  "dpc": None,
  "guest": 0.0,
  "guest_nice": 0.0,
  "idle": 24.0,
  "interrupt": None,
  "iowait": 0.0,
  "irq": 0.0,
  "key": "cpu_number",
  "nice": 0.0,
  "softirq": 0.0,
  "steal": 0.0,
  "system": 5.0,
  "total": 76.0,
  "user": 0.0},
 {"cpu_number": 1,
  "dpc": None,
  "guest": 0.0,
  "guest_nice": 0.0,
  "idle": 29.0,
  "interrupt": None,
  "iowait": 0.0,
  "irq": 0.0,
  "key": "cpu_number",
  "nice": 0.0,
  "softirq": 0.0,
  "steal": 0.0,
  "system": 0.0,
  "total": 71.0,
  "user": 0.0}]

Fields descriptions:

cpu_number: CPU number (unit is None)
total: Sum of CPU percentages (except idle) for current CPU number (unit is percent)
system: Percent time spent in kernel space. System CPU time is the time spent running code in the Operating System kernel (unit is percent)
user: CPU percent time spent in user space. User CPU time is the time spent on the processor running your program’s code (or code in libraries) (unit is percent)
iowait: (Linux): percent time spent by the CPU waiting for I/O operations to complete (unit is percent)
idle: percent of CPU used by any program. Every program or task that runs on a computer system occupies a certain amount of processing time on the CPU. If the CPU has completed all tasks it is idle (unit is percent)
irq: (Linux and BSD): percent time spent servicing/handling hardware/software interrupts. Time servicing interrupts (hardware + software) (unit is percent)
nice: (Unix): percent time occupied by user level processes with a positive nice value. The time the CPU has spent running users’ processes that have been niced (unit is percent)
steal: (Linux): percentage of time a virtual CPU waits for a real CPU while the hypervisor is servicing another virtual processor (unit is percent)
guest: (Linux): percent of time spent running a virtual CPU for guest operating systems under the control of the Linux kernel (unit is percent)
guest_nice: (Linux): percent of time spent running a niced guest (virtual CPU) (unit is percent)
softirq: (Linux): percent of time spent handling software interrupts (unit is percent)
dpc: (Windows): percent of time spent handling deferred procedure calls (unit is percent)
interrupt: (Windows): percent of time spent handling software interrupts (unit is percent)

Get a specific field:

# curl http://localhost:61208/api/4/percpu/cpu_number
{"cpu_number": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]}

GET ports

Get plugin stats:

# curl http://localhost:61208/api/4/ports
[{"description": "DefaultGateway",
  "host": "192.168.1.1",
  "indice": "port_0",
  "port": 0,
  "refresh": 30,
  "rtt_warning": None,
  "status": 0.006519,
  "timeout": 3}]

Fields descriptions:

host: Measurement is be done on this host (or IP address) (unit is None)
port: Measurement is be done on this port (0 for ICMP) (unit is None)
description: Human readable description for the host/port (unit is None)
refresh: Refresh time (in seconds) for this host/port (unit is None)
timeout: Timeout (in seconds) for the measurement (unit is None)
status: Measurement result (in seconds) (unit is second)
rtt_warning: Warning threshold (in seconds) for the measurement (unit is second)
indice: Unique indice for the host/port (unit is None)

Get a specific field:

# curl http://localhost:61208/api/4/ports/host
{"host": ["192.168.1.1"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/ports/host/value/192.168.1.1
{"192.168.1.1": [{"description": "DefaultGateway",
                  "host": "192.168.1.1",
                  "indice": "port_0",
                  "port": 0,
                  "refresh": 30,
                  "rtt_warning": None,
                  "status": 0.006519,
                  "timeout": 3}]}

GET processcount

Get plugin stats:

# curl http://localhost:61208/api/4/processcount
{"pid_max": 0, "running": 1, "sleeping": 415, "thread": 2084, "total": 564}

Fields descriptions:

total: Total number of processes (unit is number)
running: Total number of running processes (unit is number)
sleeping: Total number of sleeping processes (unit is number)
thread: Total number of threads (unit is number)
pid_max: Maximum number of processes (unit is number)

Get a specific field:

# curl http://localhost:61208/api/4/processcount/total
{"total": 564}

GET processlist

Get plugin stats:

# curl http://localhost:61208/api/4/processlist
[{"cmdline": ["/snap/code/226/usr/share/code/code",
              "/home/nicolargo/.vscode/extensions/ms-python.vscode-pylance-2026.2.1/dist/server.bundle.js",
              "--cancellationReceive=file:d9b079d6cf45532e61b65f3bc9aa4ad4171e8a2f85",
              "--node-ipc",
              "--clientProcessId=9915"],
  "cpu_percent": 0.0,
  "cpu_times": {"children_system": 0.79,
                "children_user": 3.67,
                "iowait": 0.0,
                "system": 12.28,
                "user": 192.06},
  "gids": {"effective": 1000, "real": 1000, "saved": 1000},
  "io_counters": [108816384,
                  417792,
                  0,
                  0,
                  0,
                  486802432,
                  219062272,
                  0,
                  0,
                  0,
                  23345152,
                  122880,
                  0,
                  0,
                  0,
                  95969280,
                  42209280,
                  0,
                  0,
                  0,
                  21748736,
                  20480,
                  0,
                  0,
                  0,
                  36664320,
                  1407008768,
                  0,
                  0,
                  0,
                  34781184,
                  0,
                  0,
                  0,
                  0,
                  2734080,
                  0,
                  0,
                  0,
                  0,
                  616448,
                  0,
                  0,
                  0,
                  0,
                  121856,
                  0,
                  0,
                  0,
                  0,
                  3375104,
                  0,
                  0,
                  0,
                  0,
                  3760128,
                  29786112,
                  0,
                  0,
                  0,
                  1240064,
                  0,
                  0,
                  0,
                  0,
                  988160,
                  13963264,
                  0,
                  0,
                  0],
  "key": "pid",
  "memory_info": {"data": 1548865536,
                  "dirty": 0,
                  "lib": 0,
                  "rss": 901931008,
                  "shared": 76783616,
                  "text": 148103168,
                  "vms": 1501545361408},
  "memory_percent": 5.492472475653434,
  "name": "code",
  "nice": 0,
  "num_threads": 12,
  "pid": 10763,
  "status": "S",
  "time_since_update": 1,
  "username": "nicolargo"},
 {"cmdline": ["/proc/self/exe",
              "--type=utility",
              "--utility-sub-type=node.mojom.NodeService",
              "--lang=en-US",
              "--service-sandbox-type=none",
              "--no-sandbox",
              "--dns-result-order=ipv4first",
              "--experimental-network-inspection",
              "--inspect-port=0",
              "--crashpad-handler-pid=9702",
              "--enable-crash-reporter=864d4bb7-dd20-4851-830f-29e81dd93517,no_channel",
              "--user-data-dir=/home/nicolargo/.config/Code",
              "--standard-schemes=vscode-webview,vscode-file",
              "--secure-schemes=vscode-webview,vscode-file",
              "--cors-schemes=vscode-webview,vscode-file",
              "--fetch-schemes=vscode-webview,vscode-file",
              "--service-worker-schemes=vscode-webview",
              "--code-cache-schemes=vscode-webview,vscode-file",
              "--shared-files=v8_context_snapshot_data:100",
              "--field-trial-handle=3,i,15892380445462549536,6688096609713369601,262144",
              "--enable-features=DocumentPolicyIncludeJSCallStacksInCrashReports,EarlyEstablishGpuChannel,EstablishGpuChannelAsync",
              "--disable-features=CalculateNativeWinOcclusion,LocalNetworkAccessChecks,ScreenAIOCREnabled,SpareRendererForSitePerProcess,TraceSiteInstanceGetProcessCreation",
              "--variations-seed-version",
              "--trace-process-track-uuid=3190708993808206286"],
  "cpu_percent": 0.0,
  "cpu_times": {"children_system": 165.45,
                "children_user": 115.72,
                "iowait": 0.0,
                "system": 113.29,
                "user": 269.99},
  "gids": {"effective": 1000, "real": 1000, "saved": 1000},
  "io_counters": [486802432, 219062272, 0, 0, 0],
  "key": "pid",
  "memory_info": {"data": 1932468224,
                  "dirty": 0,
                  "lib": 0,
                  "rss": 783872000,
                  "shared": 92696576,
                  "text": 148103168,
                  "vms": 1515351912448},
  "memory_percent": 4.7735307315605775,
  "name": "code",
  "nice": 0,
  "num_threads": 22,
  "pid": 9915,
  "status": "S",
  "time_since_update": 1,
  "username": "nicolargo"}]

Fields descriptions:

pid: Process identifier (ID) (unit is number)
name: Process name (unit is string)
cmdline: Command line with arguments (unit is list)
username: Process owner (unit is string)
num_threads: Number of threads (unit is number)
cpu_percent: Process CPU consumption (returned value can be > 100.0 in case of a process running multiple threads on different CPU cores) (unit is percent)
memory_percent: Process memory consumption (unit is percent)
memory_info: Process memory information (dict with rss, vms, shared, text, lib, data, dirty keys) (unit is byte)
status: Process status (unit is string)
nice: Process nice value (unit is number)
cpu_times: Process CPU times (dict with user, system, iowait keys) (unit is second)
gids: Process group IDs (dict with real, effective, saved keys) (unit is number)
io_counters: Process IO counters (list with read_count, write_count, read_bytes, write_bytes, io_tag keys) (unit is byte)
cpu_num: CPU core number where the process is currently executing (0-based indexing) (unit is number)

GET programlist

Get plugin stats:

# curl http://localhost:61208/api/4/programlist
[{"childrens": [10763,
                9915,
                9831,
                9685,
                11529,
                9930,
                9931,
                9863,
                10305,
                10374,
                11332,
                9790,
                9687,
                9688],
  "cmdline": ["code"],
  "cpu_percent": 0,
  "cpu_times": {"children_system": 169.21999999999997,
                "children_user": 136.51,
                "system": 268.64,
                "user": 1418.2000000000005},
  "io_counters": [108816384,
                  417792,
                  0,
                  0,
                  0,
                  486802432,
                  219062272,
                  0,
                  0,
                  0,
                  23345152,
                  122880,
                  0,
                  0,
                  0,
                  95969280,
                  42209280,
                  0,
                  0,
                  0,
                  21748736,
                  20480,
                  0,
                  0,
                  0,
                  36664320,
                  1407008768,
                  0,
                  0,
                  0,
                  34781184,
                  0,
                  0,
                  0,
                  0,
                  2734080,
                  0,
                  0,
                  0,
                  0,
                  616448,
                  0,
                  0,
                  0,
                  0,
                  121856,
                  0,
                  0,
                  0,
                  0,
                  3375104,
                  0,
                  0,
                  0,
                  0,
                  3760128,
                  29786112,
                  0,
                  0,
                  0,
                  1240064,
                  0,
                  0,
                  0,
                  0,
                  988160,
                  13963264,
                  0,
                  0,
                  0],
  "memory_info": {"data": 10781794304,
                  "rss": 3446276096,
                  "shared": 1145774080,
                  "text": 2073444352,
                  "vms": 15193043632128},
  "memory_percent": 20.986723411090853,
  "name": "code",
  "nice": 0,
  "nprocs": 14,
  "num_threads": 231,
  "pid": "_",
  "status": "S",
  "time_since_update": 1,
  "username": "nicolargo"},
 {"childrens": [6978],
  "cmdline": ["firefox"],
  "cpu_percent": 0,
  "cpu_times": {"children_system": 0.47,
                "children_user": 0.14,
                "iowait": 0.0,
                "system": 272.94,
                "user": 793.2},
  "io_counters": [788421632, 1931038720, 0, 0, 0],
  "memory_info": {"data": 955289600,
                  "dirty": 0,
                  "lib": 0,
                  "rss": 703524864,
                  "shared": 288358400,
                  "text": 659456,
                  "vms": 30116978688},
  "memory_percent": 4.284242272617182,
  "name": "firefox",
  "nice": 0,
  "nprocs": 1,
  "num_threads": 132,
  "pid": "_",
  "status": "S",
  "time_since_update": 1,
  "username": "nicolargo"}]

Fields descriptions:

pid: Process identifier (ID) (unit is number)
name: Process name (unit is string)
cmdline: Command line with arguments (unit is list)
username: Process owner (unit is string)
num_threads: Number of threads (unit is number)
cpu_percent: Process CPU consumption (returned value can be > 100.0 in case of a process running multiple threads on different CPU cores) (unit is percent)
memory_percent: Process memory consumption (unit is percent)
memory_info: Process memory information (dict with rss, vms, shared, text, lib, data, dirty keys) (unit is byte)
status: Process status (unit is string)
nice: Process nice value (unit is number)
cpu_times: Process CPU times (dict with user, system, iowait keys) (unit is second)
gids: Process group IDs (dict with real, effective, saved keys) (unit is number)
io_counters: Process IO counters (list with read_count, write_count, read_bytes, write_bytes, io_tag keys) (unit is byte)
cpu_num: CPU core number where the process is currently executing (0-based indexing) (unit is number)

GET psutilversion

Get plugin stats:

# curl http://localhost:61208/api/4/psutilversion
"7.2.2"

GET quicklook

Get plugin stats:

# curl http://localhost:61208/api/4/quicklook
{"cpu": 5.8,
 "cpu_hz": 4475000000.0,
 "cpu_hz_current": 1059334187.5000001,
 "cpu_log_core": 16,
 "cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H",
 "cpu_phys_core": 10,
 "load": 4.3,
 "mem": 63.7,
 "percpu": [{"cpu_number": 0,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 24.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 5.0,
             "total": 76.0,
             "user": 0.0},
            {"cpu_number": 1,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 2,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 1.0},
            {"cpu_number": 3,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 30.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 70.0,
             "user": 0.0},
            {"cpu_number": 4,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 24.0,
             "interrupt": None,
             "iowait": 2.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 3.0,
             "total": 76.0,
             "user": 1.0},
            {"cpu_number": 5,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 30.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 70.0,
             "user": 0.0},
            {"cpu_number": 6,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 12.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 11.0,
             "total": 88.0,
             "user": 5.0},
            {"cpu_number": 7,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 8,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 9,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 30.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 70.0,
             "user": 0.0},
            {"cpu_number": 10,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 11,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 12,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 13,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 14,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0},
            {"cpu_number": 15,
             "dpc": None,
             "guest": 0.0,
             "guest_nice": 0.0,
             "idle": 29.0,
             "interrupt": None,
             "iowait": 0.0,
             "irq": 0.0,
             "key": "cpu_number",
             "nice": 0.0,
             "softirq": 0.0,
             "steal": 0.0,
             "system": 0.0,
             "total": 71.0,
             "user": 0.0}],
 "swap": 9.8}

Fields descriptions:

cpu: CPU percent usage (unit is percent)
mem: MEM percent usage (unit is percent)
swap: SWAP percent usage (unit is percent)
load: LOAD percent usage (unit is percent)
cpu_log_core: Number of logical CPU core (unit is number)
cpu_phys_core: Number of physical CPU core (unit is number)
cpu_name: CPU name (unit is None)
cpu_hz_current: CPU current frequency (unit is hertz)
cpu_hz: CPU max frequency (unit is hertz)

Get a specific field:

# curl http://localhost:61208/api/4/quicklook/cpu_name
{"cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H"}

GET raid

Get plugin stats:

# curl http://localhost:61208/api/4/raid
{}

GET sensors

Get plugin stats:

# curl http://localhost:61208/api/4/sensors
[{"critical": None,
  "key": "label",
  "label": "Ambient",
  "type": "temperature_core",
  "unit": "C",
  "value": 39,
  "warning": 0},
 {"critical": None,
  "key": "label",
  "label": "Ambient 3",
  "type": "temperature_core",
  "unit": "C",
  "value": 33,
  "warning": 0}]

Fields descriptions:

label: Sensor label (unit is None)
unit: Sensor unit (unit is None)
value: Sensor value (unit is number)
warning: System warning threshold (regardless of the user configuration in the glances.conf file) (unit is number)
critical: System critical threshold (regardless of the user configuration in the glances.conf file) (unit is number)
type: Sensor type (one of battery, temperature_core, fan_speed) (unit is None)

Get a specific field:

# curl http://localhost:61208/api/4/sensors/label
{"label": ["Ambient",
           "Ambient 3",
           "Ambient 5",
           "Ambient 6",
           "CPU",
           "Composite",
           "Core 0",
           "Core 4",
           "Core 8",
           "Core 12",
           "Core 16",
           "Core 20",
           "Core 28",
           "Core 29",
           "Core 30",
           "Core 31",
           "HDD",
           "Package id 0",
           "SODIMM",
           "Sensor 1",
           "Sensor 2",
           "dell_smm 0",
           "dell_smm 1",
           "dell_smm 2",
           "dell_smm 3",
           "dell_smm 4",
           "dell_smm 5",
           "dell_smm 6",
           "dell_smm 7",
           "dell_smm 8",
           "dell_smm 9",
           "i915 0",
           "iwlwifi_1 0",
           "temp",
           "CPU Fan",
           "Video Fan",
           "dell_smm 0",
           "dell_smm 1",
           "i915 0",
           "BAT BAT0"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/sensors/label/value/Ambient
{"Ambient": [{"critical": None,
              "key": "label",
              "label": "Ambient",
              "type": "temperature_core",
              "unit": "C",
              "value": 39,
              "warning": 0}]}

GET smart

Get plugin stats:

# curl http://localhost:61208/api/4/smart
{}

GET system

Get plugin stats:

# curl http://localhost:61208/api/4/system
{"hostname": "nicolargo-xps15",
 "hr_name": "Ubuntu 24.04 64bit / Linux 6.17.0-19-generic",
 "linux_distro": "Ubuntu 24.04",
 "os_name": "Linux",
 "os_version": "6.17.0-19-generic",
 "platform": "64bit"}

Fields descriptions:

os_name: Operating system name (unit is None)
hostname: Hostname (unit is None)
platform: Platform (32 or 64 bits) (unit is None)
linux_distro: Linux distribution (unit is None)
os_version: Operating system version (unit is None)
hr_name: Human readable operating system name (unit is None)

Get a specific field:

# curl http://localhost:61208/api/4/system/os_name
{"os_name": "Linux"}

GET uptime

Get plugin stats:

# curl http://localhost:61208/api/4/uptime
"1 day, 0:50:00"

GET version

Get plugin stats:

# curl http://localhost:61208/api/4/version
"4.5.4"

GET vms

Get plugin stats:

# curl http://localhost:61208/api/4/vms
{}

Fields descriptions:

name: Vm name (unit is None)
id: Vm ID (unit is None)
release: Vm release (unit is None)
status: Vm status (unit is None)
cpu_count: Vm CPU count (unit is None)
cpu_time: Vm CPU time (unit is percent)
cpu_time_rate_per_sec: Vm CPU time per second (unit is percent per second)
cpu_time_gauge: Vm CPU time (cumulative) (unit is percent)
memory_usage: Vm memory usage (unit is byte)
memory_total: Vm memory total (unit is byte)
load_1min: Vm Load last 1 min (unit is None)
load_5min: Vm Load last 5 mins (unit is None)
load_15min: Vm Load last 15 mins (unit is None)
ipv4: Vm IP v4 address (unit is None)
engine: VM engine name (unit is None)
engine_version: VM engine version (unit is None)
time_since_update: Number of seconds since last update (unit is seconds)

GET wifi

Get plugin stats:

# curl http://localhost:61208/api/4/wifi
[{"key": "ssid",
  "quality_level": -59.0,
  "quality_link": 51.0,
  "ssid": "wlp0s20f3"}]

Get a specific field:

# curl http://localhost:61208/api/4/wifi/ssid
{"ssid": ["wlp0s20f3"]}

Get a specific item when field matches the given value:

# curl http://localhost:61208/api/4/wifi/ssid/value/wlp0s20f3
{"wlp0s20f3": [{"key": "ssid",
                "quality_level": -59.0,
                "quality_link": 51.0,
                "ssid": "wlp0s20f3"}]}

GET all stats

Get all Glances stats:

# curl http://localhost:61208/api/4/all
Return a very big dictionary with all stats

Note: Update is done automatically every time /all or /<plugin> is called.

GET stats of a specific process

Get stats for process with PID == 777:

# curl http://localhost:61208/api/4/processes/777
Return stats for process (dict)

Enable extended stats for process with PID == 777 (only one process at a time can be enabled):

# curl -X POST http://localhost:61208/api/4/processes/extended/777
# curl http://localhost:61208/api/4/all
# curl http://localhost:61208/api/4/processes/777
Return stats for process (dict)

Note: Update is not done automatically when you call /processes/<pid>.

GET top n items of a specific plugin

Get top 2 processes of the processlist plugin:

# curl http://localhost:61208/api/4/processlist/top/2
[]

Note: Only work for plugin with a list of items

GET item description

Get item description (human readable) for a specific plugin/item:

# curl http://localhost:61208/api/4/diskio/read_bytes/description
"Number of bytes read."

Note: the description is defined in the fields_description variable of the plugin.

GET item unit

Get item unit for a specific plugin/item:

# curl http://localhost:61208/api/4/diskio/read_bytes/unit
"byte"

Note: the description is defined in the fields_description variable of the plugin.

GET stats history

History of a plugin:

# curl http://localhost:61208/api/4/cpu/history
{"system": [["2026-04-19T07:37:40.865671+00:00", 2.6],
            ["2026-04-19T07:37:41.922375+00:00", 0.7],
            ["2026-04-19T07:37:42.938441+00:00", 0.7]],
 "user": [["2026-04-19T07:37:40.865665+00:00", 3.6],
          ["2026-04-19T07:37:41.922373+00:00", 0.8],
          ["2026-04-19T07:37:42.938440+00:00", 0.8]]}

Limit history to last 2 values:

# curl http://localhost:61208/api/4/cpu/history/2
{"system": [["2026-04-19T07:37:41.922375+00:00", 0.7],
            ["2026-04-19T07:37:42.938441+00:00", 0.7]],
 "user": [["2026-04-19T07:37:41.922373+00:00", 0.8],
          ["2026-04-19T07:37:42.938440+00:00", 0.8]]}

History for a specific field:

# curl http://localhost:61208/api/4/cpu/system/history
{"system": [["2026-04-19T07:37:39.682650+00:00", 2.6],
            ["2026-04-19T07:37:40.865671+00:00", 2.6],
            ["2026-04-19T07:37:41.922375+00:00", 0.7],
            ["2026-04-19T07:37:42.938441+00:00", 0.7]]}

Limit history for a specific field to last 2 values:

# curl http://localhost:61208/api/4/cpu/system/history
{"system": [["2026-04-19T07:37:41.922375+00:00", 0.7],
            ["2026-04-19T07:37:42.938441+00:00", 0.7]]}

GET limits (used for thresholds)

All limits/thresholds:

# curl http://localhost:61208/api/4/all/limits
{"alert": {"alert_disable": ["False"], "history_size": 1200.0},
 "amps": {"amps_disable": ["False"], "history_size": 1200.0},
 "containers": {"containers_all": ["False"],
                "containers_disable": ["False"],
                "containers_disable_stats": ["command"],
                "containers_max_name_size": 20.0,
                "history_size": 1200.0},
 "core": {"history_size": 1200.0},
 "cpu": {"cpu_ctx_switches_careful": 640000.0,
         "cpu_ctx_switches_critical": 800000.0,
         "cpu_ctx_switches_warning": 720000.0,
         "cpu_disable": ["False"],
         "cpu_iowait_careful": 5.0,
         "cpu_iowait_critical": 6.25,
         "cpu_iowait_warning": 5.625,
         "cpu_steal_careful": 50.0,
         "cpu_steal_critical": 90.0,
         "cpu_steal_warning": 70.0,
         "cpu_system_careful": 50.0,
         "cpu_system_critical": 90.0,
         "cpu_system_log": ["False"],
         "cpu_system_warning": 70.0,
         "cpu_total_careful": 65.0,
         "cpu_total_critical": 85.0,
         "cpu_total_log": ["True"],
         "cpu_total_warning": 75.0,
         "cpu_user_careful": 50.0,
         "cpu_user_critical": 90.0,
         "cpu_user_log": ["False"],
         "cpu_user_warning": 70.0,
         "history_size": 1200.0},
 "diskio": {"diskio_disable": ["False"],
            "diskio_hide": ["loop.*", "/dev/loop.*"],
            "diskio_hide_zero": ["False"],
            "diskio_rx_latency_careful": 10.0,
            "diskio_rx_latency_critical": 50.0,
            "diskio_rx_latency_warning": 20.0,
            "diskio_tx_latency_careful": 10.0,
            "diskio_tx_latency_critical": 50.0,
            "diskio_tx_latency_warning": 20.0,
            "history_size": 1200.0},
 "folders": {"folders_disable": ["False"],
             "folders_refresh": 60.0,
             "history_size": 1200.0},
 "fs": {"fs_careful": 50.0,
        "fs_critical": 90.0,
        "fs_disable": ["False"],
        "fs_hide": ["/boot.*", ".*/snap.*"],
        "fs_refresh": 60.0,
        "fs_warning": 70.0,
        "history_size": 1200.0},
 "gpu": {"gpu_disable": ["False"],
         "gpu_mem_careful": 50.0,
         "gpu_mem_critical": 90.0,
         "gpu_mem_warning": 70.0,
         "gpu_proc_careful": 50.0,
         "gpu_proc_critical": 90.0,
         "gpu_proc_warning": 70.0,
         "gpu_temperature_careful": 60.0,
         "gpu_temperature_critical": 80.0,
         "gpu_temperature_warning": 70.0,
         "history_size": 1200.0},
 "help": {"history_size": 1200.0},
 "ip": {"history_size": 1200.0,
        "ip_disable": ["False"],
        "ip_public_api": ["https://ipv4.ipleak.net/json/"],
        "ip_public_disabled": ["True"],
        "ip_public_field": ["ip"],
        "ip_public_refresh_interval": 300.0,
        "ip_public_template": ["{continent_name}/{country_name}/{city_name}"],
        "ip_refresh": 60.0},
 "load": {"history_size": 1200.0,
          "load_careful": 0.7,
          "load_critical": 5.0,
          "load_disable": ["False"],
          "load_warning": 1.0},
 "mem": {"history_size": 1200.0,
         "mem_careful": 50.0,
         "mem_critical": 90.0,
         "mem_disable": ["False"],
         "mem_warning": 70.0},
 "memswap": {"history_size": 1200.0,
             "memswap_careful": 50.0,
             "memswap_critical": 90.0,
             "memswap_disable": ["False"],
             "memswap_warning": 70.0},
 "network": {"history_size": 1200.0,
             "network_disable": ["False"],
             "network_hide": ["docker.*", "lo"],
             "network_hide_no_ip": ["True"],
             "network_hide_no_up": ["True"],
             "network_hide_zero": ["False"],
             "network_rx_careful": 70.0,
             "network_rx_critical": 90.0,
             "network_rx_warning": 80.0,
             "network_tx_careful": 70.0,
             "network_tx_critical": 90.0,
             "network_tx_warning": 80.0},
 "now": {"history_size": 1200.0},
 "percpu": {"history_size": 1200.0,
            "percpu_disable": ["False"],
            "percpu_iowait_careful": 50.0,
            "percpu_iowait_critical": 90.0,
            "percpu_iowait_warning": 70.0,
            "percpu_max_cpu_display": 4.0,
            "percpu_system_careful": 50.0,
            "percpu_system_critical": 90.0,
            "percpu_system_warning": 70.0,
            "percpu_user_careful": 50.0,
            "percpu_user_critical": 90.0,
            "percpu_user_warning": 70.0},
 "ports": {"history_size": 1200.0,
           "ports_disable": ["False"],
           "ports_port_default_gateway": ["True"],
           "ports_refresh": 30.0,
           "ports_timeout": 3.0},
 "processcount": {"history_size": 1200.0, "processcount_disable": ["False"]},
 "processlist": {"history_size": 1200.0,
                 "processlist_cpu_careful": 50.0,
                 "processlist_cpu_critical": 90.0,
                 "processlist_cpu_warning": 70.0,
                 "processlist_disable": ["False"],
                 "processlist_disable_stats": ["cpu_num"],
                 "processlist_mem_careful": 50.0,
                 "processlist_mem_critical": 90.0,
                 "processlist_mem_warning": 70.0,
                 "processlist_nice_warning": ["-20",
                                              "-19",
                                              "-18",
                                              "-17",
                                              "-16",
                                              "-15",
                                              "-14",
                                              "-13",
                                              "-12",
                                              "-11",
                                              "-10",
                                              "-9",
                                              "-8",
                                              "-7",
                                              "-6",
                                              "-5",
                                              "-4",
                                              "-3",
                                              "-2",
                                              "-1",
                                              "1",
                                              "2",
                                              "3",
                                              "4",
                                              "5",
                                              "6",
                                              "7",
                                              "8",
                                              "9",
                                              "10",
                                              "11",
                                              "12",
                                              "13",
                                              "14",
                                              "15",
                                              "16",
                                              "17",
                                              "18",
                                              "19"],
                 "processlist_status_critical": ["Z", "D"],
                 "processlist_status_ok": ["R", "W", "P", "I"]},
 "programlist": {"history_size": 1200.0},
 "psutilversion": {"history_size": 1200.0},
 "quicklook": {"history_size": 1200.0,
               "quicklook_bar_char": ["▪"],
               "quicklook_cpu_careful": 50.0,
               "quicklook_cpu_critical": 90.0,
               "quicklook_cpu_warning": 70.0,
               "quicklook_disable": ["False"],
               "quicklook_list": ["cpu", "mem", "load"],
               "quicklook_load_careful": 70.0,
               "quicklook_load_critical": 500.0,
               "quicklook_load_warning": 100.0,
               "quicklook_mem_careful": 50.0,
               "quicklook_mem_critical": 90.0,
               "quicklook_mem_warning": 70.0,
               "quicklook_swap_careful": 50.0,
               "quicklook_swap_critical": 90.0,
               "quicklook_swap_warning": 70.0},
 "sensors": {"history_size": 1200.0,
             "sensors_battery_careful": 70.0,
             "sensors_battery_critical": 90.0,
             "sensors_battery_warning": 80.0,
             "sensors_disable": ["False"],
             "sensors_hide": ["unknown.*"],
             "sensors_refresh": 10.0,
             "sensors_temperature_core_careful": 45.0,
             "sensors_temperature_core_critical": 80.0,
             "sensors_temperature_core_warning": 65.0,
             "sensors_temperature_hdd_careful": 45.0,
             "sensors_temperature_hdd_critical": 60.0,
             "sensors_temperature_hdd_warning": 52.0},
 "system": {"history_size": 1200.0,
            "system_disable": ["False"],
            "system_refresh": 60},
 "uptime": {"history_size": 1200.0},
 "version": {"history_size": 1200.0},
 "wifi": {"history_size": 1200.0,
          "wifi_careful": -65.0,
          "wifi_critical": -85.0,
          "wifi_disable": ["False"],
          "wifi_warning": -75.0}}

Limits/thresholds for the cpu plugin:

# curl http://localhost:61208/api/4/cpu/limits
{"cpu_ctx_switches_careful": 640000.0,
 "cpu_ctx_switches_critical": 800000.0,
 "cpu_ctx_switches_warning": 720000.0,
 "cpu_disable": ["False"],
 "cpu_iowait_careful": 5.0,
 "cpu_iowait_critical": 6.25,
 "cpu_iowait_warning": 5.625,
 "cpu_steal_careful": 50.0,
 "cpu_steal_critical": 90.0,
 "cpu_steal_warning": 70.0,
 "cpu_system_careful": 50.0,
 "cpu_system_critical": 90.0,
 "cpu_system_log": ["False"],
 "cpu_system_warning": 70.0,
 "cpu_total_careful": 65.0,
 "cpu_total_critical": 85.0,
 "cpu_total_log": ["True"],
 "cpu_total_warning": 75.0,
 "cpu_user_careful": 50.0,
 "cpu_user_critical": 90.0,
 "cpu_user_log": ["False"],
 "cpu_user_warning": 70.0,
 "history_size": 1200.0}