2016-03-02 15:29:19 +03:00
.. _api:
2021-07-17 10:31:07 +03:00
API (Restfull/JSON) documentation
=================================
2016-03-02 15:29:19 +03:00
2021-07-17 10:31:07 +03:00
The Glances Restfull/API server could be ran using the following command line:
2016-03-02 15:29:19 +03:00
2021-07-17 10:31:07 +03:00
.. code-block :: bash
2016-03-02 15:29:19 +03:00
2021-07-17 10:31:07 +03:00
# glances -w --disable-webui
2023-06-04 11:44:42 +03:00
API URL
-------
The default root API URL is `` http://localhost:61208/api/3 `` .
2023-07-14 10:01:29 +03:00
The bind address and port could be changed using the `` --bind `` and `` --port `` command line options.
2023-06-04 11:44:42 +03:00
It is also possible to define an URL prefix using the `` url_prefix `` option from the [outputs] section
of the Glances configuration file. The url_prefix should always end with a slash (`` / `` ).
For example:
.. code-block :: ini
[outputs]
url_prefix = /glances/
will change the root API URL to `` http://localhost:61208/glances/api/3 `` and the Web UI URL to
`` http://localhost:61208/glances/ ``
2021-07-17 10:31:07 +03:00
2022-01-15 13:34:52 +03:00
GET API status
--------------
This entry point should be used to check the API status.
2023-07-14 10:01:29 +03:00
It will return nothing but a 200 return code if everything is OK.
2022-01-15 13:34:52 +03:00
2022-01-15 13:38:21 +03:00
Get the Rest API status::
2022-01-15 13:34:52 +03:00
# curl -I http://localhost:61208/api/3/status
2022-05-22 17:27:46 +03:00
"HTTP/1.0 200 OK"
2022-01-15 13:34:52 +03:00
2021-07-17 10:49:28 +03:00
GET plugins list
2021-07-17 10:31:07 +03:00
----------------
2022-01-15 13:38:21 +03:00
Get the plugins list::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/pluginslist
2022-05-22 17:27:46 +03:00
["alert",
"amps",
"cloud",
"connections",
2023-05-08 10:26:04 +03:00
"containers",
2022-05-22 17:27:46 +03:00
"core",
"cpu",
"diskio",
"folders",
"fs",
"gpu",
"help",
"ip",
"irq",
"load",
"mem",
"memswap",
"network",
"now",
"percpu",
"ports",
"processcount",
"processlist",
"psutilversion",
"quicklook",
"raid",
"sensors",
"smart",
"system",
"uptime",
"wifi"]
2021-11-22 13:54:04 +03:00
2021-07-17 10:31:07 +03:00
GET amps
--------
2022-01-15 13:38:21 +03:00
Get plugin stats::
2021-07-17 10:31:07 +03:00
# curl http://localhost:61208/api/3/amps
2022-05-22 17:27:46 +03:00
[{"count": 0,
"countmax": None,
"countmin": 1.0,
"key": "name",
"name": "Dropbox",
"refresh": 3.0,
"regex": True,
"result": None,
2023-11-01 10:53:44 +03:00
"timer": 0.16420912742614746},
2022-05-22 17:27:46 +03:00
{"count": 0,
"countmax": 20.0,
"countmin": None,
"key": "name",
"name": "Python",
"refresh": 3.0,
"regex": True,
"result": None,
2023-11-01 10:53:44 +03:00
"timer": 0.16410183906555176}]
2022-09-24 20:03:04 +03:00
Get a specific field::
# curl http://localhost:61208/api/3/amps/name
{"name": ["Dropbox", "Python", "Conntrack", "Nginx", "Systemd", "SystemV"]}
2023-07-14 10:01:29 +03:00
Get a specific item when field matches the given value::
2022-09-24 20:03:04 +03:00
# curl http://localhost:61208/api/3/amps/name/Dropbox
{"Dropbox": [{"count": 0,
"countmax": None,
"countmin": 1.0,
"key": "name",
"name": "Dropbox",
"refresh": 3.0,
"regex": True,
"result": None,
2023-11-01 10:53:44 +03:00
"timer": 0.16420912742614746}]}
2021-07-17 10:31:07 +03:00
2023-05-08 10:26:04 +03:00
GET connections
2021-07-17 10:31:07 +03:00
---------------
2022-01-15 13:38:21 +03:00
Get plugin stats::
2021-07-17 10:31:07 +03:00
2023-05-08 10:26:04 +03:00
# curl http://localhost:61208/api/3/connections
{"net_connections_enabled": True, "nf_conntrack_enabled": True}
2021-07-17 10:31:07 +03:00
2022-09-24 20:03:04 +03:00
Get a specific field::
2023-05-08 10:26:04 +03:00
# curl http://localhost:61208/api/3/connections/net_connections_enabled
{"net_connections_enabled": True}
2021-07-17 10:31:07 +03:00
2023-05-08 10:26:04 +03:00
GET containers
--------------
2021-07-17 10:31:07 +03:00
2022-01-15 13:38:21 +03:00
Get plugin stats::
2021-07-17 10:31:07 +03:00
2023-05-08 10:26:04 +03:00
# curl http://localhost:61208/api/3/containers
2023-11-01 10:53:44 +03:00
{"containers": [{"Command": ["/portainer"],
2023-07-15 10:01:05 +03:00
"Created": "2022-10-29T14:59:10.266701439Z",
"Id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb",
"Image": ["portainer/portainer-ce:2.9.3"],
"Status": "running",
2023-11-01 10:53:44 +03:00
"Uptime": "6 mins",
2023-07-15 10:01:05 +03:00
"cpu": {"total": 0.0},
"cpu_percent": 0.0,
"engine": "docker",
2023-08-14 11:31:07 +03:00
"io": {},
2023-07-15 10:01:05 +03:00
"io_r": None,
"io_w": None,
"key": "name",
2023-08-14 11:31:07 +03:00
"memory": {},
"memory_usage": None,
2023-07-15 10:01:05 +03:00
"name": "portainer",
2023-08-14 11:31:07 +03:00
"network": {},
2023-07-15 10:01:05 +03:00
"network_rx": None,
2023-08-14 11:31:07 +03:00
"network_tx": None}],
2023-05-13 11:47:29 +03:00
"version": {},
"version_podman": {}}
GET core
--------
Get plugin stats::
# curl http://localhost:61208/api/3/core
{"log": 4, "phys": 2}
Fields descriptions:
* **phys** : Number of physical cores (hyper thread CPUs are excluded) (unit is *number* )
* **log** : Number of logical CPUs. 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/3/core/phys
{"phys": 2}
GET cpu
-------
Get plugin stats::
# curl http://localhost:61208/api/3/cpu
{"cpucore": 4,
"ctx_switches": 0,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 73.9,
2023-05-13 11:47:29 +03:00
"interrupts": 0,
2023-11-01 10:53:44 +03:00
"iowait": 0.9,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
2023-10-07 11:24:05 +03:00
"nice": 0.0,
2023-05-13 11:47:29 +03:00
"soft_interrupts": 0,
2023-11-01 10:53:44 +03:00
"softirq": 0.0,
2023-05-13 11:47:29 +03:00
"steal": 0.0,
"syscalls": 0,
2023-11-01 10:53:44 +03:00
"system": 4.5,
2023-05-13 11:47:29 +03:00
"time_since_update": 1,
2023-11-01 10:53:44 +03:00
"total": 25.2,
"user": 20.7}
2023-05-13 11:47:29 +03:00
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* )
* **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* )
* **interrupts** : number of interrupts per second (unit is *number* )
* **soft_interrupts** : number of software interrupts per second. Always set to 0 on Windows and SunOS (unit is *number* )
* **syscalls** : number of system calls per second. Always 0 on Linux OS (unit is *number* )
* **cpucore** : Total number of CPU core (unit is *number* )
* **time_since_update** : Number of seconds since last update (unit is *seconds* )
Get a specific field::
# curl http://localhost:61208/api/3/cpu/total
2023-11-01 10:53:44 +03:00
{"total": 25.2}
2023-05-13 11:47:29 +03:00
GET diskio
----------
Get plugin stats::
# curl http://localhost:61208/api/3/diskio
[{"disk_name": "sda",
"key": "disk_name",
"read_bytes": 0,
"read_count": 0,
"time_since_update": 1,
"write_bytes": 0,
"write_count": 0},
{"disk_name": "sda1",
"key": "disk_name",
"read_bytes": 0,
"read_count": 0,
"time_since_update": 1,
"write_bytes": 0,
"write_count": 0}]
Get a specific field::
# curl http://localhost:61208/api/3/diskio/disk_name
2023-11-01 10:53:44 +03:00
{"disk_name": ["sda", "sda1", "sda2", "sda5", "dm-0", "dm-1", "sdb", "sdb1"]}
2023-05-13 11:47:29 +03:00
2023-07-14 10:01:29 +03:00
Get a specific item when field matches the given value::
2023-05-13 11:47:29 +03:00
# curl http://localhost:61208/api/3/diskio/disk_name/sda
{"sda": [{"disk_name": "sda",
"key": "disk_name",
"read_bytes": 0,
"read_count": 0,
"time_since_update": 1,
"write_bytes": 0,
"write_count": 0}]}
GET fs
------
Get plugin stats::
# curl http://localhost:61208/api/3/fs
[{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
2023-11-01 10:53:44 +03:00
"free": 30865014784,
2023-05-13 11:47:29 +03:00
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
2023-11-01 10:53:44 +03:00
"percent": 86.6,
2023-05-13 11:47:29 +03:00
"size": 243334156288,
2023-11-01 10:53:44 +03:00
"used": 200081686528},
2023-05-13 11:47:29 +03:00
{"device_name": "zsfpool",
"free": 41811968,
"fs_type": "zfs",
"key": "mnt_point",
"mnt_point": "/zsfpool",
"percent": 0.3,
"size": 41943040,
"used": 131072}]
Get a specific field::
# curl http://localhost:61208/api/3/fs/mnt_point
{"mnt_point": ["/", "/zsfpool", "/var/snap/firefox/common/host-hunspell"]}
2023-07-14 10:01:29 +03:00
Get a specific item when field matches the given value::
2023-05-13 11:47:29 +03:00
# curl http://localhost:61208/api/3/fs/mnt_point//
{"/": [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
2023-11-01 10:53:44 +03:00
"free": 30865014784,
2023-05-13 11:47:29 +03:00
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
2023-11-01 10:53:44 +03:00
"percent": 86.6,
2023-05-13 11:47:29 +03:00
"size": 243334156288,
2023-11-01 10:53:44 +03:00
"used": 200081686528}]}
2023-05-13 11:47:29 +03:00
GET ip
------
Get plugin stats::
# curl http://localhost:61208/api/3/ip
2023-11-01 10:53:44 +03:00
{"address": "192.168.1.14",
"gateway": "192.168.1.1",
2023-05-13 11:47:29 +03:00
"mask": "255.255.255.0",
"mask_cidr": 24,
2023-11-01 10:53:44 +03:00
"public_address": "92.151.148.66",
2023-05-13 11:47:29 +03:00
"public_info_human": ""}
Get a specific field::
# curl http://localhost:61208/api/3/ip/gateway
2023-11-01 10:53:44 +03:00
{"gateway": "192.168.1.1"}
2023-05-13 11:47:29 +03:00
GET load
--------
Get plugin stats::
# curl http://localhost:61208/api/3/load
2023-10-07 11:24:05 +03:00
{"cpucore": 4,
2023-11-01 10:53:44 +03:00
"min1": 1.16650390625,
"min15": 1.2255859375,
"min5": 1.3173828125}
2023-05-13 11:47:29 +03:00
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* )
Get a specific field::
# curl http://localhost:61208/api/3/load/min1
2023-11-01 10:53:44 +03:00
{"min1": 1.16650390625}
2023-05-13 11:47:29 +03:00
GET mem
-------
Get plugin stats::
# curl http://localhost:61208/api/3/mem
2023-11-01 10:53:44 +03:00
{"active": 2796564480,
"available": 2493652992,
"buffers": 401641472,
"cached": 2819747840,
"free": 2493652992,
"inactive": 3942461440,
"percent": 68.1,
"shared": 551772160,
"total": 7823585280,
"used": 5329932288}
2023-05-13 11:47:29 +03:00
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 (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* )
Get a specific field::
# curl http://localhost:61208/api/3/mem/total
2023-11-01 10:53:44 +03:00
{"total": 7823585280}
2023-05-13 11:47:29 +03:00
GET memswap
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/memswap
2023-11-01 10:53:44 +03:00
{"free": 5963968512,
"percent": 26.2,
"sin": 513867776,
"sout": 2566475776,
2023-05-13 11:47:29 +03:00
"time_since_update": 1,
"total": 8082419712,
2023-11-01 10:53:44 +03:00
"used": 2118451200}
2023-05-13 11:47:29 +03:00
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/3/memswap/total
{"total": 8082419712}
GET network
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/network
[{"alias": None,
2023-11-01 10:53:44 +03:00
"cumulative_cx": 31635408,
"cumulative_rx": 15817704,
"cumulative_tx": 15817704,
2023-08-14 11:31:07 +03:00
"cx": 0,
2023-05-13 11:47:29 +03:00
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
2023-08-14 11:31:07 +03:00
"rx": 0,
2023-05-13 11:47:29 +03:00
"speed": 0,
"time_since_update": 1,
2023-08-14 11:31:07 +03:00
"tx": 0},
2023-05-13 11:47:29 +03:00
{"alias": None,
2023-11-01 10:53:44 +03:00
"cumulative_cx": 23666156944,
"cumulative_rx": 23525021295,
"cumulative_tx": 141135649,
"cx": 126,
2023-05-13 11:47:29 +03:00
"interface_name": "wlp2s0",
"is_up": True,
"key": "interface_name",
2023-11-01 10:53:44 +03:00
"rx": 0,
2023-05-13 11:47:29 +03:00
"speed": 0,
"time_since_update": 1,
2023-11-01 10:53:44 +03:00
"tx": 126}]
2023-05-13 11:47:29 +03:00
Fields descriptions:
* **interface_name** : Interface name (unit is *string* )
* **alias** : Interface alias name (optional) (unit is *string* )
* **rx** : The received/input rate (in bit per second) (unit is *bps* )
* **tx** : The sent/output rate (in bit per second) (unit is *bps* )
* **cx** : The cumulative received+sent rate (in bit per second) (unit is *bps* )
* **cumulative_rx** : The number of bytes received through the interface (cumulative) (unit is *bytes* )
* **cumulative_tx** : The number of bytes sent through the interface (cumulative) (unit is *bytes* )
* **cumulative_cx** : The cumulative number of bytes reveived and sent through the interface (cumulative) (unit is *bytes* )
* **speed** : Maximum interface speed (in bit per second). Can return 0 on some operating-system (unit is *bps* )
* **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/3/network/interface_name
{"interface_name": ["lo",
"wlp2s0",
"br_grafana",
2023-11-01 10:53:44 +03:00
"br-40875d2e2716",
2023-08-14 11:31:07 +03:00
"docker0",
2023-07-24 21:03:46 +03:00
"mpqemubr0",
2023-11-01 10:53:44 +03:00
"vethe1b1351"]}
2023-05-13 11:47:29 +03:00
2023-07-14 10:01:29 +03:00
Get a specific item when field matches the given value::
2023-05-13 11:47:29 +03:00
# curl http://localhost:61208/api/3/network/interface_name/lo
{"lo": [{"alias": None,
2023-11-01 10:53:44 +03:00
"cumulative_cx": 31635408,
"cumulative_rx": 15817704,
"cumulative_tx": 15817704,
2023-08-14 11:31:07 +03:00
"cx": 0,
2023-05-13 11:47:29 +03:00
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
2023-08-14 11:31:07 +03:00
"rx": 0,
2023-05-13 11:47:29 +03:00
"speed": 0,
"time_since_update": 1,
2023-08-14 11:31:07 +03:00
"tx": 0}]}
2023-05-13 11:47:29 +03:00
GET now
-------
Get plugin stats::
# curl http://localhost:61208/api/3/now
2023-11-01 10:53:44 +03:00
"2023-11-01 08:51:27 CET"
2023-05-13 11:47:29 +03:00
GET percpu
----------
Get plugin stats::
# curl http://localhost:61208/api/3/percpu
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 16.0,
2023-07-15 10:01:05 +03:00
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
2023-11-01 10:53:44 +03:00
"system": 2.0,
"total": 84.0,
"user": 9.0},
2023-05-13 11:47:29 +03:00
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 15.0,
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
2023-10-07 11:24:05 +03:00
"nice": 0.0,
2023-05-13 11:47:29 +03:00
"softirq": 0.0,
"steal": 0.0,
2023-10-07 11:24:05 +03:00
"system": 1.0,
2023-11-01 10:53:44 +03:00
"total": 85.0,
"user": 13.0}]
2023-05-13 11:47:29 +03:00
Get a specific field::
# curl http://localhost:61208/api/3/percpu/cpu_number
{"cpu_number": [0, 1, 2, 3]}
GET ports
---------
Get plugin stats::
# curl http://localhost:61208/api/3/ports
[{"description": "DefaultGateway",
2023-11-01 10:53:44 +03:00
"host": "192.168.1.1",
2023-05-13 11:47:29 +03:00
"indice": "port_0",
"port": 0,
"refresh": 30,
"rtt_warning": None,
2023-11-01 10:53:44 +03:00
"status": 0.01277,
2023-05-13 11:47:29 +03:00
"timeout": 3}]
Get a specific field::
# curl http://localhost:61208/api/3/ports/host
2023-11-01 10:53:44 +03:00
{"host": ["192.168.1.1"]}
2023-05-13 11:47:29 +03:00
2023-07-14 10:01:29 +03:00
Get a specific item when field matches the given value::
2023-05-13 11:47:29 +03:00
2023-11-01 10:53:44 +03:00
# curl http://localhost:61208/api/3/ports/host/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.01277,
"timeout": 3}]}
2023-05-13 11:47:29 +03:00
GET processcount
----------------
Get plugin stats::
# curl http://localhost:61208/api/3/processcount
2023-11-01 10:53:44 +03:00
{"pid_max": 0, "running": 1, "sleeping": 314, "thread": 1662, "total": 386}
2023-05-13 11:47:29 +03:00
Get a specific field::
# curl http://localhost:61208/api/3/processcount/total
2023-11-01 10:53:44 +03:00
{"total": 386}
2023-05-13 11:47:29 +03:00
GET psutilversion
-----------------
Get plugin stats::
# curl http://localhost:61208/api/3/psutilversion
[5, 9, 5]
GET quicklook
-------------
Get plugin stats::
# curl http://localhost:61208/api/3/quicklook
2023-11-01 10:53:44 +03:00
{"cpu": 25.2,
2023-10-07 11:24:05 +03:00
"cpu_hz": 3000000000.0,
2023-11-01 10:53:44 +03:00
"cpu_hz_current": 2844080000.0,
2023-05-13 11:47:29 +03:00
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
2023-11-01 10:53:44 +03:00
"mem": 68.1,
2023-05-13 11:47:29 +03:00
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 16.0,
2023-07-15 10:01:05 +03:00
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
2023-11-01 10:53:44 +03:00
"system": 2.0,
"total": 84.0,
"user": 9.0},
2023-05-13 11:47:29 +03:00
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 15.0,
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
2023-10-07 11:24:05 +03:00
"nice": 0.0,
2023-05-13 11:47:29 +03:00
"softirq": 0.0,
"steal": 0.0,
2023-10-07 11:24:05 +03:00
"system": 1.0,
2023-11-01 10:53:44 +03:00
"total": 85.0,
"user": 13.0},
2023-05-13 11:47:29 +03:00
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 26.0,
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
2023-07-15 10:01:05 +03:00
"softirq": 0.0,
2023-05-13 11:47:29 +03:00
"steal": 0.0,
2023-10-07 11:24:05 +03:00
"system": 1.0,
2023-11-01 10:53:44 +03:00
"total": 74.0,
"user": 1.0},
2023-05-13 11:47:29 +03:00
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
2023-11-01 10:53:44 +03:00
"idle": 26.0,
2023-10-07 11:24:05 +03:00
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
2023-10-07 11:24:05 +03:00
"nice": 0.0,
2023-08-14 11:31:07 +03:00
"softirq": 0.0,
2023-05-13 11:47:29 +03:00
"steal": 0.0,
2023-11-01 10:53:44 +03:00
"system": 1.0,
"total": 74.0,
"user": 1.0}],
"swap": 26.2}
2023-05-13 11:47:29 +03:00
Get a specific field::
# curl http://localhost:61208/api/3/quicklook/cpu
2023-11-01 10:53:44 +03:00
{"cpu": 25.2}
2023-05-13 11:47:29 +03:00
GET sensors
-----------
Get plugin stats::
# curl http://localhost:61208/api/3/sensors
[{"critical": 105,
"key": "label",
"label": "acpitz 0",
"type": "temperature_core",
"unit": "C",
"value": 27,
"warning": 105},
{"critical": 105,
"key": "label",
"label": "acpitz 1",
"type": "temperature_core",
"unit": "C",
"value": 29,
"warning": 105}]
Get a specific field::
# curl http://localhost:61208/api/3/sensors/label
{"label": ["acpitz 0",
"acpitz 1",
"Package id 0",
"Core 0",
"Core 1",
"CPU",
"Ambient",
"SODIMM",
"BAT BAT0"]}
2023-07-14 10:01:29 +03:00
Get a specific item when field matches the given value::
2023-05-13 11:47:29 +03:00
# curl http://localhost:61208/api/3/sensors/label/acpitz 0
{"acpitz 0": [{"critical": 105,
"key": "label",
"label": "acpitz 0",
"type": "temperature_core",
"unit": "C",
"value": 27,
"warning": 105}]}
GET system
----------
Get plugin stats::
# curl http://localhost:61208/api/3/system
{"hostname": "XPS13-9333",
"hr_name": "Ubuntu 22.04 64bit",
"linux_distro": "Ubuntu 22.04",
"os_name": "Linux",
2023-11-01 10:53:44 +03:00
"os_version": "5.15.0-86-generic",
2023-05-13 11:47:29 +03:00
"platform": "64bit"}
Get a specific field::
# curl http://localhost:61208/api/3/system/os_name
{"os_name": "Linux"}
GET uptime
----------
Get plugin stats::
# curl http://localhost:61208/api/3/uptime
2023-11-01 10:53:44 +03:00
"10 days, 23:38:54"
2023-05-13 11:47:29 +03:00
GET all stats
-------------
Get all Glances stats::
# curl http://localhost:61208/api/3/all
2023-07-14 10:01:29 +03:00
Return a very big dictionary (avoid using this request, performances will be poor)...
2023-05-13 11:47:29 +03:00
2023-08-14 11:31:07 +03:00
GET top n items of a specific plugin
------------------------------------
Get top 2 processes of the processlist plugin::
# curl http://localhost:61208/api/3/processlist/top/2
2023-11-01 10:53:44 +03:00
[{"cmdline": ["/snap/firefox/3206/usr/lib/firefox/firefox",
2023-08-14 11:31:07 +03:00
"-contentproc",
"-childID",
2023-11-01 10:53:44 +03:00
"2",
2023-08-14 11:31:07 +03:00
"-isForBrowser",
"-prefsLen",
2023-11-01 10:53:44 +03:00
"35837",
2023-08-14 11:31:07 +03:00
"-prefMapSize",
2023-11-01 10:53:44 +03:00
"231968",
2023-08-14 11:31:07 +03:00
"-jsInitLen",
2023-11-01 10:53:44 +03:00
"234236",
2023-08-14 11:31:07 +03:00
"-parentBuildID",
2023-11-01 10:53:44 +03:00
"20230928054334",
"-greomni",
"/snap/firefox/3206/usr/lib/firefox/omni.ja",
"-appomni",
"/snap/firefox/3206/usr/lib/firefox/browser/omni.ja",
2023-08-14 11:31:07 +03:00
"-appDir",
2023-11-01 10:53:44 +03:00
"/snap/firefox/3206/usr/lib/firefox/browser",
"{e8cdf5ea-b126-4cf3-8a2c-4ecf8bfa42cb}",
"6779",
2023-08-14 11:31:07 +03:00
"true",
"tab"],
"cpu_percent": 0.0,
2023-11-01 10:53:44 +03:00
"cpu_times": pcputimes(user=223.59, system=25.59, children_user=0.0, children_system=0.0, iowait=0.0),
2023-08-14 11:31:07 +03:00
"gids": pgids(real=1000, effective=1000, saved=1000),
2023-11-01 10:53:44 +03:00
"io_counters": [159959040, 0, 0, 0, 0],
2023-08-14 11:31:07 +03:00
"key": "pid",
2023-11-01 10:53:44 +03:00
"memory_info": pmem(rss=512262144, vms=3362086912, shared=29282304, text=643072, lib=0, data=803278848, dirty=0),
"memory_percent": 6.547664857818231,
2023-08-14 11:31:07 +03:00
"name": "WebExtensions",
"nice": 0,
"num_threads": 20,
2023-11-01 10:53:44 +03:00
"pid": 7049,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"},
{"cmdline": ["/snap/firefox/3206/usr/lib/firefox/firefox"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=2099.05, system=541.02, children_user=748.27, children_system=70.57, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [19097014272, 22883790848, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=428056576, vms=13759758336, shared=111906816, text=643072, lib=0, data=1674182656, dirty=0),
"memory_percent": 5.471360772333781,
"name": "firefox",
"nice": 0,
"num_threads": 183,
"pid": 6779,
2023-08-14 11:31:07 +03:00
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]
Note: Only work for plugin with a list of items
2023-05-13 11:47:29 +03:00
GET stats history
-----------------
History of a plugin::
# curl http://localhost:61208/api/3/cpu/history
2023-11-01 10:53:44 +03:00
{"system": [["2023-11-01T08:51:29.392317", 4.5],
["2023-11-01T08:51:30.420589", 1.6],
["2023-11-01T08:51:31.542866", 1.6]],
"user": [["2023-11-01T08:51:29.392306", 20.7],
["2023-11-01T08:51:30.420582", 9.5],
["2023-11-01T08:51:31.542854", 9.5]]}
2023-05-13 11:47:29 +03:00
Limit history to last 2 values::
# curl http://localhost:61208/api/3/cpu/history/2
2023-11-01 10:53:44 +03:00
{"system": [["2023-11-01T08:51:30.420589", 1.6],
["2023-11-01T08:51:31.542866", 1.6]],
"user": [["2023-11-01T08:51:30.420582", 9.5],
["2023-11-01T08:51:31.542854", 9.5]]}
2023-05-13 11:47:29 +03:00
History for a specific field::
# curl http://localhost:61208/api/3/cpu/system/history
2023-11-01 10:53:44 +03:00
{"system": [["2023-11-01T08:51:27.776605", 4.5],
["2023-11-01T08:51:29.392317", 4.5],
["2023-11-01T08:51:30.420589", 1.6],
["2023-11-01T08:51:31.542866", 1.6]]}
2023-05-13 11:47:29 +03:00
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/3/cpu/system/history
2023-11-01 10:53:44 +03:00
{"system": [["2023-11-01T08:51:30.420589", 1.6],
["2023-11-01T08:51:31.542866", 1.6]]}
2023-05-13 11:47:29 +03:00
GET limits (used for thresholds)
--------------------------------
All limits/thresholds::
# curl http://localhost:61208/api/3/all/limits
2023-10-07 11:24:05 +03:00
{"alert": {"alert_disable": ["False"], "history_size": 1200.0},
2023-05-13 11:47:29 +03:00
"amps": {"amps_disable": ["False"], "history_size": 1200.0},
"containers": {"containers_all": ["False"],
"containers_disable": ["False"],
"containers_max_name_size": 20.0,
"history_size": 1200.0},
"core": {"history_size": 1200.0},
"cpu": {"cpu_ctx_switches_careful": 160000.0,
"cpu_ctx_switches_critical": 200000.0,
"cpu_ctx_switches_warning": 180000.0,
"cpu_disable": ["False"],
"cpu_iowait_careful": 20.0,
"cpu_iowait_critical": 25.0,
"cpu_iowait_warning": 22.5,
"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.* "],
"history_size": 1200.0},
"folders": {"folders_disable": ["False"], "history_size": 1200.0},
"fs": {"fs_careful": 50.0,
"fs_critical": 90.0,
"fs_disable": ["False"],
"fs_hide": ["/boot.*", "/snap.* "],
"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,
"history_size": 1200.0},
"help": {"history_size": 1200.0},
"ip": {"history_size": 1200.0,
"ip_censys_fields": ["location:continent",
"location:country",
"autonomous_system:name"],
"ip_censys_url": ["https://search.censys.io/api"],
"ip_disable": ["False"],
"ip_public_ip_disabled": ["False"],
"ip_public_refresh_interval": 300.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_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_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_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"]},
"psutilversion": {"history_size": 1200.0},
"quicklook": {"history_size": 1200.0,
"quicklook_cpu_careful": 50.0,
"quicklook_cpu_critical": 90.0,
"quicklook_cpu_warning": 70.0,
"quicklook_disable": ["False"],
"quicklook_mem_careful": 50.0,
"quicklook_mem_critical": 90.0,
"quicklook_mem_warning": 70.0,
"quicklook_percentage_char": ["|"],
"quicklook_swap_careful": 50.0,
"quicklook_swap_critical": 90.0,
"quicklook_swap_warning": 70.0},
"sensors": {"history_size": 1200.0,
"sensors_battery_careful": 80.0,
"sensors_battery_critical": 95.0,
"sensors_battery_warning": 90.0,
"sensors_disable": ["False"],
"sensors_refresh": 4.0,
"sensors_temperature_core_careful": 60.0,
"sensors_temperature_core_critical": 80.0,
"sensors_temperature_core_warning": 70.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},
2023-07-24 21:03:46 +03:00
"uptime": {"history_size": 1200.0},
"wifi": {"history_size": 1200.0,
"wifi_careful": -65.0,
"wifi_critical": -85.0,
"wifi_disable": ["False"],
"wifi_warning": -75.0}}
2023-05-13 11:47:29 +03:00
Limits/thresholds for the cpu plugin::
# curl http://localhost:61208/api/3/cpu/limits
{"cpu_ctx_switches_careful": 160000.0,
"cpu_ctx_switches_critical": 200000.0,
"cpu_ctx_switches_warning": 180000.0,
"cpu_disable": ["False"],
"cpu_iowait_careful": 20.0,
"cpu_iowait_critical": 25.0,
"cpu_iowait_warning": 22.5,
"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}
