API (Restfull/JSON) documentation
The Glances Restfull/API server could be ran using the following command line:
# glances -w --disable-webui
Note: Change request URL api/3 by api/2 if you use Glances 2.x.
GET API status
This entry point should be used to check the API status. It will return nothing but a 200 return code if everythin is OK.
Get the Rest API status:
# curl -I http://localhost:61208/api/3/status
"HTTP/1.0 200 OK"
GET plugins list
Get the plugins list:
# curl http://localhost:61208/api/3/pluginslist
["alert",
"amps",
"cloud",
"connections",
"core",
"cpu",
"diskio",
"docker",
"folders",
"fs",
"gpu",
"help",
"ip",
"irq",
"load",
"mem",
"memswap",
"network",
"now",
"percpu",
"ports",
"processcount",
"processlist",
"psutilversion",
"quicklook",
"raid",
"sensors",
"smart",
"system",
"uptime",
"wifi"]
GET amps
Get plugin stats:
# curl http://localhost:61208/api/3/amps
[{"count": 0,
"countmax": None,
"countmin": 1.0,
"key": "name",
"name": "Dropbox",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 1.3143589496612549},
{"count": 0,
"countmax": 20.0,
"countmin": None,
"key": "name",
"name": "Python",
"refresh": 3.0,
"regex": True,
"result": None,
"timer": 1.3141794204711914}]
Get a specific field:
# curl http://localhost:61208/api/3/amps/name
{"name": ["Dropbox", "Python", "Conntrack", "Nginx", "Systemd", "SystemV"]}
Get a specific item when field matchs the given value:
# 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,
"timer": 1.3143589496612549}]}
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,
"idle": 62.9,
"interrupts": 0,
"iowait": 0.5,
"irq": 0.0,
"nice": 0.0,
"soft_interrupts": 0,
"softirq": 0.2,
"steal": 0.0,
"syscalls": 0,
"system": 7.3,
"time_since_update": 1,
"total": 39.9,
"user": 29.1}
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
{"total": 39.9}
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
{"disk_name": ["sda", "sda1", "sda2", "sda5", "dm-0", "dm-1"]}
Get a specific item when field matchs the given value:
# 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",
"free": 75419246592,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 67.3,
"size": 243334156288,
"used": 155527454720},
{"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"]}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/fs/mnt_point//
{"/": [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
"free": 75419246592,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
"percent": 67.3,
"size": 243334156288,
"used": 155527454720}]}
GET ip
Get plugin stats:
# curl http://localhost:61208/api/3/ip
{"address": "192.168.0.48",
"gateway": "192.168.0.254",
"mask": "255.255.255.0",
"mask_cidr": 24,
"public_address": "82.66.169.82",
"public_info_human": ""}
Get a specific field:
# curl http://localhost:61208/api/3/ip/gateway
{"gateway": "192.168.0.254"}
GET load
Get plugin stats:
# curl http://localhost:61208/api/3/load
{"cpucore": 4,
"min1": 2.3291015625,
"min15": 1.5380859375,
"min5": 1.7373046875}
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
{"min1": 2.3291015625}
GET mem
Get plugin stats:
# curl http://localhost:61208/api/3/mem
{"active": 2978480128,
"available": 3161673728,
"buffers": 244125696,
"cached": 3262550016,
"free": 3161673728,
"inactive": 3275505664,
"percent": 59.7,
"shared": 586371072,
"total": 7836188672,
"used": 4674514944}
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
{"total": 7836188672}
GET memswap
Get plugin stats:
# curl http://localhost:61208/api/3/memswap
{"free": 7162478592,
"percent": 11.4,
"sin": 109473792,
"sout": 1032638464,
"time_since_update": 1,
"total": 8082419712,
"used": 919941120}
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,
"cumulative_cx": 113157324,
"cumulative_rx": 56578662,
"cumulative_tx": 56578662,
"cx": 7360,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 3680,
"speed": 0,
"time_since_update": 1,
"tx": 3680},
{"alias": None,
"cumulative_cx": 2969111409,
"cumulative_rx": 2797340945,
"cumulative_tx": 171770464,
"cx": 29759,
"interface_name": "wlp2s0",
"is_up": True,
"key": "interface_name",
"rx": 21778,
"speed": 0,
"time_since_update": 1,
"tx": 7981}]
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)
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)
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-87386b77b676",
"br_grafana",
"br-119e6ee04e05",
"docker0",
"mpqemubr0"]}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/network/interface_name/lo
{"lo": [{"alias": None,
"cumulative_cx": 113157324,
"cumulative_rx": 56578662,
"cumulative_tx": 56578662,
"cx": 7360,
"interface_name": "lo",
"is_up": True,
"key": "interface_name",
"rx": 3680,
"speed": 0,
"time_since_update": 1,
"tx": 3680}]}
GET now
Get plugin stats:
# curl http://localhost:61208/api/3/now
"2022-10-17 23:12:12 CEST"
GET percpu
Get plugin stats:
# curl http://localhost:61208/api/3/percpu
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 58.5,
"iowait": 0.7,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 10.9,
"total": 41.5,
"user": 29.9},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 72.1,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 8.8,
"total": 27.9,
"user": 19.0}]
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",
"host": "192.168.0.254",
"indice": "port_0",
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.005792,
"timeout": 3}]
Get a specific field:
# curl http://localhost:61208/api/3/ports/host
{"host": ["192.168.0.254"]}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/ports/host/192.168.0.254
{"192.168.0.254": [{"description": "DefaultGateway",
"host": "192.168.0.254",
"indice": "port_0",
"port": 0,
"refresh": 30,
"rtt_warning": None,
"status": 0.005792,
"timeout": 3}]}
GET processcount
Get plugin stats:
# curl http://localhost:61208/api/3/processcount
{"pid_max": 0, "running": 2, "sleeping": 275, "thread": 1380, "total": 408}
Get a specific field:
# curl http://localhost:61208/api/3/processcount/total
{"total": 408}
GET processlist
Get plugin stats:
# curl http://localhost:61208/api/3/processlist
[{"cmdline": ["/snap/firefox/1877/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"4",
"-isForBrowser",
"-prefsLen",
"35977",
"-prefMapSize",
"236080",
"-jsInitLen",
"246848",
"-parentBuildID",
"20220922230616",
"-appDir",
"/snap/firefox/1877/usr/lib/firefox/browser",
"{8b6f29ad-9cbd-4eac-aac5-a3a7552fe4c0}",
"4281",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=698.64, system=134.67, children_user=0.0, children_system=0.0, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [15293440, 0, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=456249344, vms=3429462016, shared=94203904, text=634880, lib=0, data=830988288, dirty=0),
"memory_percent": 5.822337402751091,
"name": "WebExtensions",
"nice": 0,
"num_threads": 21,
"pid": 4719,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"},
{"cmdline": ["/snap/firefox/1877/usr/lib/firefox/firefox"],
"cpu_percent": 0.0,
"cpu_times": pcputimes(user=3579.74, system=1266.77, children_user=3450.07, children_system=675.16, iowait=0.0),
"gids": pgids(real=1000, effective=1000, saved=1000),
"io_counters": [1342131200, 4212867072, 0, 0, 0],
"key": "pid",
"memory_info": pmem(rss=449769472, vms=13370167296, shared=140492800, text=634880, lib=0, data=1428529152, dirty=0),
"memory_percent": 5.739645774572795,
"name": "firefox",
"nice": 0,
"num_threads": 147,
"pid": 4281,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]
Get a specific field:
# curl http://localhost:61208/api/3/processlist/pid
{"pid": [4719,
4281,
17308,
17501,
4494,
107498,
3549,
4498,
5818,
17347,
132804,
4463,
107499,
19717,
17233,
107901,
11646,
17346,
134243,
109608,
134024,
17274,
134358,
9453,
2245,
133063,
4055,
3499,
134578,
5126,
17754,
3958,
58814,
17755,
17566,
17373,
4440,
3844,
51440,
5659,
2429,
3651,
1405,
17292,
4062,
3364,
1615,
3627,
3743,
3744,
4977,
3737,
1567,
1381,
3806,
3663,
1369,
1539,
2371,
1945,
17237,
2412,
1391,
3592,
1,
1587,
3760,
3618,
4087,
1415,
49142,
17238,
3929,
3742,
2917,
133194,
3528,
3739,
49148,
51420,
2187,
3444,
3345,
3736,
16698,
3557,
3891,
3750,
3353,
3745,
3637,
1593,
1416,
1487,
3817,
1352,
1917,
1412,
14997,
4518,
2405,
1408,
3599,
3755,
3569,
15018,
3943,
3905,
3741,
54676,
1368,
1392,
3697,
3380,
3373,
3378,
2406,
3547,
3588,
129936,
3804,
1375,
3813,
3604,
3753,
3799,
3734,
3747,
11667,
3633,
1407,
3583,
3729,
3748,
54624,
3385,
3437,
3616,
1397,
3361,
2920,
1399,
17516,
3362,
3517,
3556,
1365,
1360,
1743,
1367,
1176,
1377,
1470,
3953,
58637,
17258,
134554,
3221,
58407,
54523,
1363,
4187,
3354,
1353,
134577,
3425,
2208,
3733,
1485,
2252,
58639,
2226,
2,
3,
4,
5,
7,
9,
10,
11,
12,
13,
14,
15,
16,
18,
19,
20,
21,
22,
24,
25,
26,
27,
28,
30,
31,
32,
33,
34,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
92,
93,
94,
96,
97,
98,
99,
100,
101,
103,
105,
106,
108,
110,
112,
114,
118,
119,
121,
130,
133,
139,
188,
195,
196,
197,
198,
199,
200,
201,
202,
210,
211,
216,
217,
234,
283,
284,
359,
362,
386,
485,
495,
559,
560,
561,
562,
778,
779,
780,
781,
788,
789,
790,
791,
792,
793,
794,
795,
848,
849,
850,
851,
852,
853,
854,
855,
856,
857,
858,
859,
860,
861,
862,
863,
864,
865,
866,
890,
891,
898,
899,
915,
916,
917,
918,
919,
920,
921,
1891,
1897,
2256,
2266,
3584,
17240,
48942,
48943,
48945,
58642,
58643,
58644,
58645,
58646,
58647,
58648,
58649,
58650,
119746,
121888,
125962,
127836,
127858,
128360,
128474,
128785,
129047,
129124,
129249,
129890,
129929,
130063,
130438,
132594,
132595,
132823,
132862,
132933,
132934,
132935,
132936,
132937,
132938,
132939,
132945,
132946,
132947,
132948,
132949,
132950,
132951,
132952,
132953,
132954,
132955,
132956,
132957,
132958,
132959,
132960,
132961,
132962,
132963,
132964,
132965,
132966,
132967,
132968,
132969,
132970,
132971,
132972,
132973,
132974,
132975,
132976,
132977,
132978,
132979,
132980,
132981,
132982,
132983,
132984,
132985,
132986,
132987,
132988,
132989,
132990,
132991,
132992,
132993,
132994,
132995,
132996,
132997,
132998,
132999,
133000,
133001,
133002,
133003,
133004,
133005,
133006,
133007,
133009,
133206]}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/processlist/pid/4719
{"4719": [{"cmdline": ["/snap/firefox/1877/usr/lib/firefox/firefox",
"-contentproc",
"-childID",
"4",
"-isForBrowser",
"-prefsLen",
"35977",
"-prefMapSize",
"236080",
"-jsInitLen",
"246848",
"-parentBuildID",
"20220922230616",
"-appDir",
"/snap/firefox/1877/usr/lib/firefox/browser",
"{8b6f29ad-9cbd-4eac-aac5-a3a7552fe4c0}",
"4281",
"true",
"tab"],
"cpu_percent": 0.0,
"cpu_times": [698.64, 134.67, 0.0, 0.0, 0.0],
"gids": [1000, 1000, 1000],
"io_counters": [15293440, 0, 0, 0, 0],
"key": "pid",
"memory_info": [456249344,
3429462016,
94203904,
634880,
0,
830988288,
0],
"memory_percent": 5.822337402751091,
"name": "WebExtensions",
"nice": 0,
"num_threads": 21,
"pid": 4719,
"status": "S",
"time_since_update": 1,
"username": "nicolargo"}]}
GET psutilversion
Get plugin stats:
# curl http://localhost:61208/api/3/psutilversion
(5, 9, 2)
GET quicklook
Get plugin stats:
# curl http://localhost:61208/api/3/quicklook
{"cpu": 39.9,
"cpu_hz": 1700000000.0,
"cpu_hz_current": 1299103000.0,
"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
"mem": 59.7,
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 58.5,
"iowait": 0.7,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 10.9,
"total": 41.5,
"user": 29.9},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 72.1,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 8.8,
"total": 27.9,
"user": 19.0},
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 59.7,
"iowait": 1.3,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
"system": 3.4,
"total": 40.3,
"user": 35.6},
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
"idle": 49.3,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.7,
"steal": 0.0,
"system": 7.3,
"total": 50.7,
"user": 42.7}],
"swap": 11.4}
Get a specific field:
# curl http://localhost:61208/api/3/quicklook/cpu
{"cpu": 39.9}
GET sensors
Get plugin stats:
# curl http://localhost:61208/api/3/sensors
[{"critical": 105,
"key": "label",
"label": "acpitz 1",
"type": "temperature_core",
"unit": "C",
"value": 27,
"warning": 105},
{"critical": 105,
"key": "label",
"label": "acpitz 2",
"type": "temperature_core",
"unit": "C",
"value": 29,
"warning": 105}]
Get a specific field:
# curl http://localhost:61208/api/3/sensors/label
{"label": ["acpitz 1",
"acpitz 2",
"Package id 0",
"Core 0",
"Core 1",
"CPU",
"Ambient",
"SODIMM",
"BAT BAT0"]}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/sensors/label/acpitz 1
{"acpitz 1": [{"critical": 105,
"key": "label",
"label": "acpitz 1",
"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",
"os_version": "5.15.0-48-generic",
"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
{"seconds": 221446}
GET all stats
Get all Glances stats:
# curl http://localhost:61208/api/3/all
Return a very big dictionnary (avoid using this request, performances will be poor)...
GET stats history
History of a plugin:
# curl http://localhost:61208/api/3/cpu/history
{"system": [["2022-10-17T23:12:13.436228", 7.3],
["2022-10-17T23:12:14.485708", 7.3],
["2022-10-17T23:12:15.715926", 3.3]],
"user": [["2022-10-17T23:12:13.436218", 29.1],
["2022-10-17T23:12:14.485700", 29.1],
["2022-10-17T23:12:15.715909", 7.8]]}
Limit history to last 2 values:
# curl http://localhost:61208/api/3/cpu/history/2
{"system": [["2022-10-17T23:12:14.485708", 7.3],
["2022-10-17T23:12:15.715926", 3.3]],
"user": [["2022-10-17T23:12:14.485700", 29.1],
["2022-10-17T23:12:15.715909", 7.8]]}
History for a specific field:
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-10-17T23:12:13.436228", 7.3],
["2022-10-17T23:12:14.485708", 7.3],
["2022-10-17T23:12:15.715926", 3.3]]}
Limit history for a specific field to last 2 values:
# curl http://localhost:61208/api/3/cpu/system/history
{"system": [["2022-10-17T23:12:14.485708", 7.3],
["2022-10-17T23:12:15.715926", 3.3]]}
GET limits (used for thresholds)
All limits/thresholds:
# curl http://localhost:61208/api/3/all/limits
{"alert": {"history_size": 3600.0},
"amps": {"amps_disable": ["False"], "history_size": 3600.0},
"cloud": {"history_size": 3600.0},
"core": {"history_size": 3600.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": 3600.0},
"diskio": {"diskio_disable": ["False"],
"diskio_hide": ["loop.*", "/dev/loop*"],
"history_size": 3600.0},
"docker": {"docker_all": ["False"],
"docker_disable": ["False"],
"docker_max_name_size": 20.0,
"history_size": 3600.0},
"folders": {"folders_disable": ["False"], "history_size": 3600.0},
"fs": {"fs_careful": 50.0,
"fs_critical": 90.0,
"fs_disable": ["False"],
"fs_hide": ["/boot.*", "/snap.*"],
"fs_warning": 70.0,
"history_size": 3600.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": 3600.0},
"help": {"history_size": 3600.0},
"ip": {"history_size": 3600.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": 3600.0,
"load_careful": 0.7,
"load_critical": 5.0,
"load_disable": ["False"],
"load_warning": 1.0},
"mem": {"history_size": 3600.0,
"mem_careful": 50.0,
"mem_critical": 90.0,
"mem_disable": ["False"],
"mem_warning": 70.0},
"memswap": {"history_size": 3600.0,
"memswap_careful": 50.0,
"memswap_critical": 90.0,
"memswap_disable": ["False"],
"memswap_warning": 70.0},
"network": {"history_size": 3600.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": 3600.0},
"percpu": {"history_size": 3600.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": 3600.0,
"ports_disable": ["False"],
"ports_port_default_gateway": ["True"],
"ports_refresh": 30.0,
"ports_timeout": 3.0},
"processcount": {"history_size": 3600.0, "processcount_disable": ["False"]},
"processlist": {"history_size": 3600.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": 3600.0},
"quicklook": {"history_size": 3600.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": 3600.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": 3600.0,
"system_disable": ["False"],
"system_refresh": 60},
"uptime": {"history_size": 3600.0}}
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": 3600.0}