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
2023-12-22 20:32:24 +03:00
This documentation describes the Glances API version 4 (Restfull/JSON) interface.
For Glances version 3, please have a look on:
`` https://github.com/nicolargo/glances/blob/support/glancesv3/docs/api.rst ``
Run the Glances API server
--------------------------
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-12-22 20:32:24 +03:00
It is also ran automatically when Glances is started in Web server mode (-w).
2023-06-04 11:44:42 +03:00
API URL
-------
2023-12-15 21:06:33 +03:00
The default root API URL is `` http://localhost:61208/api/4 `` .
2023-06-04 11:44:42 +03:00
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
2023-12-15 21:06:33 +03:00
of the Glances configuration file.
Note: The url_prefix should always end with a slash (`` / `` ).
2023-06-04 11:44:42 +03:00
For example:
.. code-block :: ini
[outputs]
url_prefix = /glances/
2023-12-15 21:06:33 +03:00
will change the root API URL to `` http://localhost:61208/glances/api/4 `` and the Web UI URL to
2023-06-04 11:44:42 +03:00
`` http://localhost:61208/glances/ ``
2023-12-22 20:32:24 +03:00
API documentation URL
---------------------
2023-12-16 16:33:30 +03:00
2023-12-22 20:32:24 +03:00
The API documentation is embeded in the server and available at the following URL:
`` http://localhost:61208/docs#/ `` .
2023-12-16 16:33:30 +03:00
WebUI refresh
-------------
2023-12-15 21:06:33 +03:00
It is possible to change the Web UI refresh rate (default is 2 seconds) using the following option in the URL:
`` http://localhost:61208/glances/?refresh=5 ``
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-12-15 21:06:33 +03:00
It will the Glances version and 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
2023-12-15 21:06:33 +03:00
# curl -I http://localhost:61208/api/4/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
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/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",
2023-12-16 16:33:30 +03:00
"version",
2022-05-22 17:27:46 +03:00
"wifi"]
2021-11-22 13:54:04 +03:00
2024-02-11 18:38:01 +03:00
GET alert
---------
Get plugin stats::
# curl http://localhost:61208/api/4/alert
2024-03-23 11:39:39 +03:00
[]
2024-02-11 18:38:01 +03:00
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* )
2024-03-23 11:39:39 +03:00
* **global_msg** : Global alert message (unit is *string* )
2024-03-16 19:00:16 +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
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/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,
2024-05-03 10:53:43 +03:00
"timer": 0.3963778018951416},
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,
2024-05-03 10:53:43 +03:00
"timer": 0.3962833881378174}]
2023-12-22 20:32:24 +03:00
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* )
2022-09-24 20:03:04 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/amps/name
2022-09-24 20:03:04 +03:00
{"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
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/amps/name/Dropbox
2022-09-24 20:03:04 +03:00
{"Dropbox": [{"count": 0,
"countmax": None,
"countmin": 1.0,
"key": "name",
"name": "Dropbox",
"refresh": 3.0,
"regex": True,
"result": None,
2024-05-03 10:53:43 +03:00
"timer": 0.3963778018951416}]}
2024-02-11 18:38:01 +03:00
GET cloud
---------
Get plugin stats::
# curl http://localhost:61208/api/4/cloud
{}
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-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/connections
2023-05-08 10:26:04 +03:00
{"net_connections_enabled": True, "nf_conntrack_enabled": True}
2021-07-17 10:31:07 +03:00
2023-12-22 20:32:24 +03:00
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* )
2022-09-24 20:03:04 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/connections/net_connections_enabled
2023-05-08 10:26:04 +03:00
{"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-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/containers
2024-04-28 10:21:58 +03:00
[]
2023-12-22 20:32:24 +03:00
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_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* )
* **uptime** : Container uptime (unit is *None* )
* **engine** : Container engine (Docker and Podman 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* )
2023-05-13 11:47:29 +03:00
GET core
--------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/core
2024-04-28 10:21:58 +03:00
{"log": 16, "phys": 10}
2023-05-13 11:47:29 +03:00
Fields descriptions:
* **phys** : Number of physical cores (hyper thread CPUs are excluded) (unit is *number* )
2024-04-07 19:20:35 +03:00
* **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* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/core/phys
2024-04-28 10:21:58 +03:00
{"phys": 10}
2023-05-13 11:47:29 +03:00
GET cpu
-------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/cpu
2024-04-28 10:21:58 +03:00
{"cpucore": 16,
2024-05-03 10:53:43 +03:00
"ctx_switches": 542181838,
2023-05-13 11:47:29 +03:00
"guest": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 3.0,
"interrupts": 420410414,
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
2024-03-16 11:23:19 +03:00
"nice": 0.0,
2024-05-03 10:53:43 +03:00
"soft_interrupts": 157550864,
2023-05-13 11:47:29 +03:00
"steal": 0.0,
"syscalls": 0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 0.0,
"user": 0.0}
2023-05-13 11:47:29 +03:00
Fields descriptions:
* **total** : Sum of all CPU percentages (except idle) (unit is *percent* )
2023-12-22 20:32:24 +03:00
* **system** : Percent time spent in kernel space. System CPU time is the time spent running code in the Operating System kernel (unit is *percent* )
2023-05-13 11:47:29 +03:00
* **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* )
2024-01-28 14:33:19 +03:00
* **guest** : *(Linux)* : time spent running a virtual CPU for guest operating systems under the control of the Linux kernel (unit is *percent* )
2023-05-13 11:47:29 +03:00
* **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* )
2024-02-03 19:38:17 +03:00
* **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* )
2023-05-13 11:47:29 +03:00
* **interrupts** : number of interrupts per second (unit is *number* )
2024-02-03 19:38:17 +03:00
* **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* )
2023-05-13 11:47:29 +03:00
* **soft_interrupts** : number of software interrupts per second. Always set to 0 on Windows and SunOS (unit is *number* )
2024-02-03 19:38:17 +03:00
* **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* )
2023-05-13 11:47:29 +03:00
* **syscalls** : number of system calls per second. Always 0 on Linux OS (unit is *number* )
2024-02-03 19:38:17 +03:00
* **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* )
2023-05-13 11:47:29 +03:00
* **cpucore** : Total number of CPU core (unit is *number* )
* **time_since_update** : Number of seconds since last update (unit is *seconds* )
2024-02-11 13:59:36 +03:00
* **time_since_update** : Number of seconds since last update (unit is *seconds* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/cpu/total
2024-05-03 10:53:43 +03:00
{"total": 0.0}
2023-05-13 11:47:29 +03:00
GET diskio
----------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/diskio
2024-04-28 10:21:58 +03:00
[{"disk_name": "nvme0n1",
2023-05-13 11:47:29 +03:00
"key": "disk_name",
2024-05-03 10:53:43 +03:00
"read_bytes": 7451868160,
"read_count": 348351,
"write_bytes": 115766309888,
"write_count": 3401479},
2024-04-28 10:21:58 +03:00
{"disk_name": "nvme0n1p1",
2023-05-13 11:47:29 +03:00
"key": "disk_name",
2024-05-03 10:53:43 +03:00
"read_bytes": 7489024,
"read_count": 601,
2024-04-28 10:21:58 +03:00
"write_bytes": 1024,
"write_count": 2}]
2023-05-13 11:47:29 +03:00
2023-12-22 20:32:24 +03:00
Fields descriptions:
* **disk_name** : Disk name (unit is *None* )
2024-02-03 19:38:17 +03:00
* **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* )
2024-02-11 13:59:36 +03:00
* **time_since_update** : Number of seconds since last update (unit is *seconds* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/diskio/disk_name
2024-04-28 10:21:58 +03:00
{"disk_name": ["nvme0n1",
"nvme0n1p1",
"nvme0n1p2",
"nvme0n1p3",
"dm-0",
"dm-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
2024-04-28 10:21:58 +03:00
# curl http://localhost:61208/api/4/diskio/disk_name/nvme0n1
{"nvme0n1": [{"disk_name": "nvme0n1",
"key": "disk_name",
2024-05-03 10:53:43 +03:00
"read_bytes": 7451868160,
"read_count": 348351,
"write_bytes": 115766309888,
"write_count": 3401479}]}
2024-02-11 18:38:01 +03:00
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* )
2023-05-13 11:47:29 +03:00
GET fs
------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/fs
2024-04-28 10:21:58 +03:00
[{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
2024-05-03 10:53:43 +03:00
"free": 915914182656,
2023-05-13 11:47:29 +03:00
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
2024-05-03 10:53:43 +03:00
"percent": 3.9,
2024-04-28 10:21:58 +03:00
"size": 1003736440832,
2024-05-03 10:53:43 +03:00
"used": 36759752704}]
2023-05-13 11:47:29 +03:00
2023-12-22 20:32:24 +03:00
Fields descriptions:
* **device_name** : Device name (unit is *None* )
* **fs_type** : File system type (unit is *None* )
* **mnt_point** : Mount point (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* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/fs/mnt_point
2024-04-28 10:21:58 +03:00
{"mnt_point": ["/"]}
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-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/fs/mnt_point//
2024-04-28 10:21:58 +03:00
{"/": [{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
2024-05-03 10:53:43 +03:00
"free": 915914182656,
2023-05-13 11:47:29 +03:00
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
2024-05-03 10:53:43 +03:00
"percent": 3.9,
2024-04-28 10:21:58 +03:00
"size": 1003736440832,
2024-05-03 10:53:43 +03:00
"used": 36759752704}]}
2024-02-11 18:38:01 +03:00
GET gpu
-------
Get plugin stats::
# curl http://localhost:61208/api/4/gpu
[]
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 help
--------
Get plugin stats::
# curl http://localhost:61208/api/4/help
None
2023-05-13 11:47:29 +03:00
GET ip
------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/ip
2024-04-28 10:21:58 +03:00
{"address": "192.168.1.26",
2024-04-25 16:36:30 +03:00
"gateway": "192.168.1.1",
2023-05-13 11:47:29 +03:00
"mask": "255.255.255.0",
"mask_cidr": 24,
2024-04-21 17:47:36 +03:00
"public_address": "",
2023-05-13 11:47:29 +03:00
"public_info_human": ""}
2023-12-22 20:32:24 +03:00
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* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/ip/gateway
2024-04-25 16:36:30 +03:00
{"gateway": "192.168.1.1"}
2023-05-13 11:47:29 +03:00
2024-02-11 18:38:01 +03:00
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* )
2023-05-13 11:47:29 +03:00
GET load
--------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/load
2024-05-03 10:53:43 +03:00
{"cpucore": 16,
"min1": 1.8212890625,
"min15": 1.0576171875,
"min5": 1.2783203125}
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::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/load/min1
2024-05-03 10:53:43 +03:00
{"min1": 1.8212890625}
2023-05-13 11:47:29 +03:00
GET mem
-------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/mem
2024-05-03 10:53:43 +03:00
{"active": 5652090880,
"available": 6879588352,
"buffers": 609959936,
"cached": 6387052544,
"free": 6879588352,
"inactive": 7342874624,
"percent": 58.1,
"shared": 1032945664,
2024-04-28 10:21:58 +03:00
"total": 16422477824,
2024-05-03 10:53:43 +03:00
"used": 9542889472}
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::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/mem/total
2024-04-28 10:21:58 +03:00
{"total": 16422477824}
2023-05-13 11:47:29 +03:00
GET memswap
-----------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/memswap
2024-05-03 10:53:43 +03:00
{"free": 4147900416,
"percent": 3.4,
"sin": 1359872,
"sout": 145010688,
2023-05-13 11:47:29 +03:00
"time_since_update": 1,
2024-04-28 10:21:58 +03:00
"total": 4294963200,
2024-05-03 10:53:43 +03:00
"used": 147062784}
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::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/memswap/total
2024-04-28 10:21:58 +03:00
{"total": 4294963200}
2023-05-13 11:47:29 +03:00
GET network
-----------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/network
2024-02-11 18:38:01 +03:00
[{"alias": None,
2024-02-11 13:59:36 +03:00
"bytes_all": 0,
2024-05-03 10:53:43 +03:00
"bytes_all_gauge": 7230851205,
2024-02-11 13:59:36 +03:00
"bytes_recv": 0,
2024-05-03 10:53:43 +03:00
"bytes_recv_gauge": 6965449347,
2024-02-11 13:59:36 +03:00
"bytes_sent": 0,
2024-05-03 10:53:43 +03:00
"bytes_sent_gauge": 265401858,
2024-04-28 10:21:58 +03:00
"interface_name": "wlp0s20f3",
2023-05-13 11:47:29 +03:00
"key": "interface_name",
"speed": 0,
2024-05-03 10:53:43 +03:00
"time_since_update": 0.39971184730529785}]
2023-05-13 11:47:29 +03:00
Fields descriptions:
2024-02-11 13:59:36 +03:00
* **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* )
2023-12-22 20:32:24 +03:00
* **speed** : Maximum interface speed (in bit per second). Can return 0 on some operating-system (unit is *bitpersecond* )
2023-05-13 11:47:29 +03:00
* **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::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/network/interface_name
2024-04-28 10:21:58 +03:00
{"interface_name": ["wlp0s20f3"]}
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
2024-04-28 10:21:58 +03:00
# curl http://localhost:61208/api/4/network/interface_name/wlp0s20f3
{"wlp0s20f3": [{"alias": None,
"bytes_all": 0,
2024-05-03 10:53:43 +03:00
"bytes_all_gauge": 7230851205,
2024-04-28 10:21:58 +03:00
"bytes_recv": 0,
2024-05-03 10:53:43 +03:00
"bytes_recv_gauge": 6965449347,
2024-04-28 10:21:58 +03:00
"bytes_sent": 0,
2024-05-03 10:53:43 +03:00
"bytes_sent_gauge": 265401858,
2024-04-28 10:21:58 +03:00
"interface_name": "wlp0s20f3",
"key": "interface_name",
"speed": 0,
2024-05-03 10:53:43 +03:00
"time_since_update": 0.39971184730529785}]}
2023-05-13 11:47:29 +03:00
GET now
-------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/now
2024-05-03 10:53:43 +03:00
{"custom": "2024-05-03 09:53:17 CEST", "iso": "2024-05-03T09:53:17+02:00"}
2024-04-28 10:21:58 +03: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
2024-05-03 10:53:43 +03:00
{"iso": "2024-05-03T09:53:17+02:00"}
2023-05-13 11:47:29 +03:00
GET percpu
----------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/percpu
2023-05-13 11:47:29 +03:00
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-24 20:47:57 +03:00
"iowait": 0.0,
2023-05-13 11:47:29 +03:00
"irq": 0.0,
"key": "cpu_number",
2024-03-16 11:23:19 +03:00
"nice": 0.0,
2024-04-28 10:21:58 +03:00
"softirq": 0.0,
2023-05-13 11:47:29 +03:00
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
"user": 0.0},
2023-05-13 11:47:29 +03:00
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-24 20:47:57 +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,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0}]
2023-12-22 20:32:24 +03:00
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* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/percpu/cpu_number
2024-04-28 10:21:58 +03:00
{"cpu_number": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]}
2023-05-13 11:47:29 +03:00
GET ports
---------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/ports
2023-05-13 11:47:29 +03:00
[{"description": "DefaultGateway",
2024-04-25 16:36:30 +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,
2024-05-03 10:53:43 +03:00
"status": 0.007143,
2023-05-13 11:47:29 +03:00
"timeout": 3}]
2023-12-22 20:32:24 +03:00
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* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2024-04-21 17:47:36 +03:00
# curl http://localhost:61208/api/4/ports/host
2024-04-25 16:36:30 +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
2024-04-25 16:36:30 +03:00
# curl http://localhost:61208/api/4/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,
2024-05-03 10:53:43 +03:00
"status": 0.007143,
2024-04-25 16:36:30 +03:00
"timeout": 3}]}
2023-05-13 11:47:29 +03:00
GET processcount
----------------
Get plugin stats::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/processcount
2024-05-03 10:53:43 +03:00
{"pid_max": 0, "running": 1, "sleeping": 292, "thread": 1754, "total": 428}
2023-12-22 20:32:24 +03:00
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* )
2023-05-13 11:47:29 +03:00
Get a specific field::
2023-12-15 21:06:33 +03:00
# curl http://localhost:61208/api/4/processcount/total
2024-05-03 10:53:43 +03:00
{"total": 428}
2024-02-11 18:38:01 +03:00
GET processlist
---------------
Get plugin stats::
# curl http://localhost:61208/api/4/processlist
2024-05-03 10:53:43 +03:00
[]
2024-02-11 18:38:01 +03:00
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 (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* )
2023-05-13 11:47:29 +03:00
2024-04-05 20:40:33 +03:00
GET psutilversion
-----------------
Get plugin stats::
# curl http://localhost:61208/api/4/psutilversion
"5.9.8"
GET quicklook
-------------
Get plugin stats::
# curl http://localhost:61208/api/4/quicklook
2024-05-03 10:53:43 +03:00
{"cpu": 0.0,
2024-04-28 10:21:58 +03:00
"cpu_hz": 4475000000.0,
2024-05-03 10:53:43 +03:00
"cpu_hz_current": 1338323312.5,
2024-04-28 10:21:58 +03:00
"cpu_log_core": 16,
"cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H",
"cpu_phys_core": 10,
2024-05-03 10:53:43 +03:00
"load": 6.6,
"mem": 58.1,
2024-04-05 20:40:33 +03:00
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-24 20:47:57 +03:00
"iowait": 0.0,
2024-04-05 20:40:33 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
2024-04-28 10:21:58 +03:00
"softirq": 0.0,
2024-04-05 20:40:33 +03:00
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
"user": 0.0},
2024-04-05 20:40:33 +03:00
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-24 20:47:57 +03:00
"iowait": 0.0,
2024-04-05 20:40:33 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0},
2024-04-05 20:40:33 +03:00
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 12:16:27 +03:00
"iowait": 0.0,
2024-04-05 20:40:33 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
2024-04-24 20:47:57 +03:00
"softirq": 0.0,
2024-04-05 20:40:33 +03:00
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
"user": 0.0},
2024-04-05 20:40:33 +03:00
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0},
{"cpu_number": 4,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
"iowait": 0.0,
2024-04-28 10:21:58 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 5,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 1.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 99.0,
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 6,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 7,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-25 16:36:30 +03:00
"iowait": 0.0,
2024-04-05 20:40:33 +03:00
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
2024-04-25 16:36:30 +03:00
"softirq": 0.0,
2024-04-05 20:40:33 +03:00
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0},
{"cpu_number": 8,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0},
{"cpu_number": 9,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0},
{"cpu_number": 10,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
2024-04-28 12:16:27 +03:00
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 11,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 1.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 99.0,
2024-04-28 10:21:58 +03:00
"user": 0.0},
{"cpu_number": 12,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
2024-05-03 10:53:43 +03:00
"system": 0.0,
"total": 100.0,
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 13,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 14,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
"user": 0.0},
2024-04-28 10:21:58 +03:00
{"cpu_number": 15,
"guest": 0.0,
"guest_nice": 0.0,
2024-05-03 10:53:43 +03:00
"idle": 0.0,
2024-04-28 10:21:58 +03:00
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 0.0,
2024-05-03 10:53:43 +03:00
"total": 100.0,
2024-04-28 10:21:58 +03:00
"user": 0.0}],
2024-05-03 10:53:43 +03:00
"swap": 3.4}
2024-04-05 20:40:33 +03:00
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* )
2024-04-07 19:20:35 +03:00
* **cpu_log_core** : Number of logical CPU core (unit is *number* )
* **cpu_phys_core** : Number of physical CPU core (unit is *number* )
2024-04-05 20:40:33 +03:00
* **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
2024-04-28 10:21:58 +03:00
{"cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H"}
2024-04-05 20:40:33 +03:00
GET raid
--------
Get plugin stats::
# curl http://localhost:61208/api/4/raid
{}
GET sensors
-----------
Get plugin stats::
# curl http://localhost:61208/api/4/sensors
2024-05-03 10:53:43 +03:00
[{"critical": None,
2024-04-05 20:40:33 +03:00
"key": "label",
2024-05-03 10:53:43 +03:00
"label": "Ambient",
2024-04-05 20:40:33 +03:00
"type": "temperature_core",
"unit": "C",
2024-05-03 10:53:43 +03:00
"value": 34,
"warning": 0},
{"critical": None,
2024-04-05 20:40:33 +03:00
"key": "label",
2024-05-03 10:53:43 +03:00
"label": "Ambient 3",
2024-04-05 20:40:33 +03:00
"type": "temperature_core",
"unit": "C",
2024-05-03 10:53:43 +03:00
"value": 29,
"warning": 0}]
2024-04-05 20:40:33 +03:00
Fields descriptions:
* **label** : Sensor label (unit is *None* )
* **unit** : Sensor unit (unit is *None* )
* **value** : Sensor value (unit is *number* )
* **warning** : Warning threshold (unit is *number* )
* **critical** : Critical threshold (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
2024-05-03 10:53:43 +03:00
{"label": ["Ambient",
2024-04-28 10:21:58 +03:00
"Ambient 3",
"Ambient 5",
"Ambient 6",
2024-05-03 10:53:43 +03:00
"CPU",
"Composite",
"Core 0",
"Core 12",
"Core 16",
"Core 20",
"Core 28",
"Core 29",
"Core 30",
"Core 31",
"Core 4",
"Core 8",
"HDD",
"Package id 0",
"SODIMM",
"Sensor 1",
"Sensor 2",
2024-04-28 10:21:58 +03:00
"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",
"iwlwifi_1 0",
"CPU Fan",
"Video Fan",
"dell_smm 0",
"dell_smm 1",
2024-04-05 20:40:33 +03:00
"BAT BAT0"]}
Get a specific item when field matches the given value::
2024-05-03 10:53:43 +03:00
# curl http://localhost:61208/api/4/sensors/label/Ambient
{"Ambient": [{"critical": None,
"key": "label",
"label": "Ambient",
"type": "temperature_core",
"unit": "C",
"value": 34,
"warning": 0}]}
2024-04-05 20:40:33 +03:00
GET smart
---------
Get plugin stats::
# curl http://localhost:61208/api/4/smart
{}
GET system
----------
Get plugin stats::
# curl http://localhost:61208/api/4/system
2024-04-28 10:21:58 +03:00
{"hostname": "nicolargo-xps15",
"hr_name": "Ubuntu 24.04 64bit / Linux 6.8.0-31-generic",
"linux_distro": "Ubuntu 24.04",
2024-04-05 20:40:33 +03:00
"os_name": "Linux",
2024-04-28 10:21:58 +03:00
"os_version": "6.8.0-31-generic",
2024-04-05 20:40:33 +03:00
"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 sytem 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
2024-05-03 10:53:43 +03:00
"5 days, 15:41:19"
2024-04-05 20:40:33 +03:00
GET version
-----------
Get plugin stats::
# curl http://localhost:61208/api/4/version
2024-05-03 10:53:43 +03:00
"4.0.0_rc02"
2024-04-05 20:40:33 +03:00
GET wifi
--------
Get plugin stats::
# curl http://localhost:61208/api/4/wifi
2024-05-03 10:53:43 +03:00
[{"key": "ssid",
"quality_level": -57.0,
"quality_link": 53.0,
"ssid": "wlp0s20f3"}]
2024-04-28 12:16:27 +03:00
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/wlp0s20f3
{"wlp0s20f3": [{"key": "ssid",
2024-05-03 10:53:43 +03:00
"quality_level": -57.0,
"quality_link": 53.0,
2024-04-28 12:16:27 +03:00
"ssid": "wlp0s20f3"}]}
2024-04-05 20:40:33 +03:00
GET all stats
-------------
Get all Glances stats::
# curl http://localhost:61208/api/4/all
Return a very big dictionary (avoid using this request, performances will be poor)...
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
2024-05-03 10:53:43 +03:00
{"system": [["2024-05-03T09:53:18.269256", 0.0],
["2024-05-03T09:53:19.320800", 0.0],
["2024-05-03T09:53:20.396402", 0.0]],
"user": [["2024-05-03T09:53:18.269244", 0.0],
["2024-05-03T09:53:19.320793", 1.0],
["2024-05-03T09:53:20.396392", 1.0]]}
2024-04-05 20:40:33 +03:00
Limit history to last 2 values::
# curl http://localhost:61208/api/4/cpu/history/2
2024-05-03 10:53:43 +03:00
{"system": [["2024-05-03T09:53:19.320800", 0.0],
["2024-05-03T09:53:20.396402", 0.0]],
"user": [["2024-05-03T09:53:19.320793", 1.0],
["2024-05-03T09:53:20.396392", 1.0]]}
2024-04-05 20:40:33 +03:00
History for a specific field::
# curl http://localhost:61208/api/4/cpu/system/history
2024-05-03 10:53:43 +03:00
{"system": [["2024-05-03T09:53:17.063839", 0.0],
["2024-05-03T09:53:18.269256", 0.0],
["2024-05-03T09:53:19.320800", 0.0],
["2024-05-03T09:53:20.396402", 0.0]]}
2024-04-05 20:40:33 +03:00
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/4/cpu/system/history
2024-05-03 10:53:43 +03:00
{"system": [["2024-05-03T09:53:19.320800", 0.0],
["2024-05-03T09:53:20.396402", 0.0]]}
2024-04-05 20:40:33 +03:00
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_max_name_size": 20.0,
"history_size": 1200.0},
"core": {"history_size": 1200.0},
2024-04-28 10:21:58 +03:00
"cpu": {"cpu_ctx_switches_careful": 640000.0,
"cpu_ctx_switches_critical": 800000.0,
"cpu_ctx_switches_warning": 720000.0,
2024-04-05 20:40:33 +03:00
"cpu_disable": ["False"],
2024-04-28 10:21:58 +03:00
"cpu_iowait_careful": 5.0,
"cpu_iowait_critical": 6.25,
"cpu_iowait_warning": 5.625,
2024-04-05 20:40:33 +03:00
"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"],
2024-04-28 10:21:58 +03:00
"fs_hide": ["/boot.*", ".* /snap.*"],
2024-04-05 20:40:33 +03:00
"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,
2024-04-07 16:32:24 +03:00
"gpu_temperature_careful": 60.0,
"gpu_temperature_critical": 80.0,
"gpu_temperature_warning": 70.0,
2024-04-05 20:40:33 +03:00
"history_size": 1200.0},
"help": {"history_size": 1200.0},
"ip": {"history_size": 1200.0,
"ip_disable": ["False"],
2024-04-21 17:47:36 +03:00
"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}"]},
2024-04-05 20:40:33 +03:00
"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_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,
2024-04-25 16:36:30 +03:00
"percpu_max_cpu_display": 4.0,
2024-04-05 20:40:33 +03:00
"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_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},
2024-04-21 17:47:36 +03:00
"raid": {"history_size": 1200.0, "raid_disable": ["False"]},
2024-04-05 20:40:33 +03:00
"sensors": {"history_size": 1200.0,
"sensors_battery_careful": 80.0,
"sensors_battery_critical": 95.0,
"sensors_battery_warning": 90.0,
"sensors_disable": ["False"],
2024-04-28 10:21:58 +03:00
"sensors_hide": ["unknown.*"],
2024-05-03 10:53:43 +03:00
"sensors_refresh": 6.0,
2024-04-05 20:40:33 +03:00
"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},
"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
2024-04-28 10:21:58 +03:00
{"cpu_ctx_switches_careful": 640000.0,
"cpu_ctx_switches_critical": 800000.0,
"cpu_ctx_switches_warning": 720000.0,
2024-04-05 20:40:33 +03:00
"cpu_disable": ["False"],
2024-04-28 10:21:58 +03:00
"cpu_iowait_careful": 5.0,
"cpu_iowait_critical": 6.25,
"cpu_iowait_warning": 5.625,
2024-04-05 20:40:33 +03:00
"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}