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 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 alert¶
Get plugin stats:
# curl http://localhost:61208/api/3/alert
[[1637578394.0,
-1,
'WARNING',
'MEM',
77.98336868856865,
77.98336868856865,
77.98336868856865,
77.98336868856865,
1,
[],
'',
'memory_percent']]
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': 0.4571521282196045},
{'count': 0,
'countmax': 20.0,
'countmin': None,
'key': 'name',
'name': 'Python',
'refresh': 3.0,
'regex': True,
'result': None,
'timer': 0.4570467472076416}]
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': 0.4571521282196045}]}
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': 78.9,
'interrupts': 0,
'iowait': 0.0,
'irq': 0.0,
'nice': 0.0,
'soft_interrupts': 0,
'softirq': 4.2,
'steal': 0.0,
'syscalls': 0,
'system': 1.7,
'time_since_update': 1,
'total': 23.7,
'user': 15.3}
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)
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': 23.7}
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': 32468828160,
'fs_type': 'ext4',
'key': 'mnt_point',
'mnt_point': '/',
'percent': 85.9,
'size': 243396149248,
'used': 198539866112}]
Get a specific field:
# curl http://localhost:61208/api/3/fs/mnt_point
{'mnt_point': ['/']}
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': 32468828160,
'fs_type': 'ext4',
'key': 'mnt_point',
'mnt_point': '/',
'percent': 85.9,
'size': 243396149248,
'used': 198539866112}]}
GET ip¶
Get plugin stats:
# curl http://localhost:61208/api/3/ip
{'address': '192.168.0.49',
'gateway': '192.168.0.254',
'mask': '255.255.255.0',
'mask_cidr': 24,
'public_address': '88.165.169.242'}
Get a specific field:
# curl http://localhost:61208/api/3/ip/address
{'address': '192.168.0.49'}
GET load¶
Get plugin stats:
# curl http://localhost:61208/api/3/load
{'cpucore': 4, 'min1': 0.58, 'min15': 0.83, 'min5': 0.81}
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': 0.58}
GET mem¶
Get plugin stats:
# curl http://localhost:61208/api/3/mem
{'active': 5202325504,
'available': 1728090112,
'buffers': 179015680,
'cached': 1851498496,
'free': 1728090112,
'inactive': 1304276992,
'percent': 78.0,
'shared': 653635584,
'total': 7849021440,
'used': 6120931328}
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': 7849021440}
GET memswap¶
Get plugin stats:
# curl http://localhost:61208/api/3/memswap
{'free': 6125826048,
'percent': 24.2,
'sin': 1044066304,
'sout': 3452276736,
'time_since_update': 1,
'total': 8082419712,
'used': 1956593664}
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': 3698139,
'cumulative_rx': 40807,
'cumulative_tx': 3657332,
'cx': 0,
'interface_name': 'docker0',
'is_up': False,
'key': 'interface_name',
'rx': 0,
'speed': 0,
'time_since_update': 1,
'tx': 0},
{'alias': None,
'cumulative_cx': 0,
'cumulative_rx': 0,
'cumulative_tx': 0,
'cx': 0,
'interface_name': 'mpqemubr0',
'is_up': False,
'key': 'interface_name',
'rx': 0,
'speed': 0,
'time_since_update': 1,
'tx': 0}]
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': ['docker0',
'mpqemubr0',
'lo',
'br-119e6ee04e05',
'wlp2s0',
'br-87386b77b676']}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/network/interface_name/docker0
{'docker0': [{'alias': None,
'cumulative_cx': 3698139,
'cumulative_rx': 40807,
'cumulative_tx': 3657332,
'cx': 0,
'interface_name': 'docker0',
'is_up': False,
'key': 'interface_name',
'rx': 0,
'speed': 0,
'time_since_update': 1,
'tx': 0}]}
GET percpu¶
Get plugin stats:
# curl http://localhost:61208/api/3/percpu
[{'cpu_number': 0,
'guest': 0.0,
'guest_nice': 0.0,
'idle': 75.2,
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 12.8,
'steal': 0.0,
'system': 1.6,
'total': 24.8,
'user': 10.4},
{'cpu_number': 1,
'guest': 0.0,
'guest_nice': 0.0,
'idle': 74.1,
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 5.2,
'steal': 0.0,
'system': 0.9,
'total': 25.9,
'user': 19.8}]
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.00653,
'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.00653,
'timeout': 3}]}
GET processcount¶
Get plugin stats:
# curl http://localhost:61208/api/3/processcount
{'pid_max': 0, 'running': 1, 'sleeping': 276, 'thread': 1306, 'total': 337}
Get a specific field:
# curl http://localhost:61208/api/3/processcount/total
{'total': 337}
GET processlist¶
Get plugin stats:
# curl http://localhost:61208/api/3/processlist
[{'cmdline': ['/usr/share/code/code',
'--type=renderer',
'--disable-color-correct-rendering',
'--field-trial-handle=9801772374554752705,8463974869748304130,131072',
'--disable-features=CookiesWithoutSameSiteMustBeSecure,SameSiteByDefaultCookies,SpareRendererForSitePerProcess',
'--lang=en-US',
'--enable-crash-reporter=7c06f526-63e8-47aa-8c08-b95f6ad2ec2d,no_channel',
'--global-crash-keys=7c06f526-63e8-47aa-8c08-b95f6ad2ec2d,no_channel,_companyName=Microsoft,_productName=VSCode,_version=1.59.1',
'--user-data-dir=/home/nicolargo/.config/Code',
'--standard-schemes=vscode-webview,vscode-file',
'--secure-schemes=vscode-webview,vscode-file',
'--bypasscsp-schemes',
'--cors-schemes=vscode-webview,vscode-file',
'--fetch-schemes=vscode-webview,vscode-file',
'--service-worker-schemes=vscode-webview',
'--streaming-schemes',
'--app-path=/usr/share/code/resources/app',
'--no-sandbox',
'--no-zygote',
'--num-raster-threads=2',
'--enable-main-frame-before-activation',
'--renderer-client-id=9',
'--no-v8-untrusted-code-mitigations',
'--shared-files=v8_context_snapshot_data:100',
'--vscode-window-config=vscode:662562c7-385c-48ce-8810-0faf0271b42a'],
'cpu_percent': 0.0,
'cpu_times': pcputimes(user=2564.47, system=206.42, children_user=7.67, children_system=1.78, iowait=1.73),
'gids': pgids(real=1000, effective=1000, saved=1000),
'io_counters': [360050688, 18534400, 0, 0, 0],
'key': 'pid',
'memory_info': pmem(rss=936550400, vms=54797201408, shared=102572032, text=125108224, lib=0, data=1184972800, dirty=0),
'memory_percent': 11.932065763346927,
'name': 'code',
'nice': 0,
'num_threads': 20,
'pid': 239588,
'ppid': 238897,
'status': 'S',
'time_since_update': 1,
'username': 'nicolargo'},
{'cmdline': ['/usr/lib/firefox/firefox', '-new-window'],
'cpu_percent': 0.0,
'cpu_times': pcputimes(user=15195.95, system=4955.03, children_user=11265.99, children_system=2186.87, iowait=5.58),
'gids': pgids(real=1000, effective=1000, saved=1000),
'io_counters': [4802973696, 20086890496, 0, 0, 0],
'key': 'pid',
'memory_info': pmem(rss=908619776, vms=5204819968, shared=122499072, text=626688, lib=0, data=1517690880, dirty=0),
'memory_percent': 11.576217276838015,
'name': 'firefox',
'nice': 0,
'num_threads': 152,
'pid': 5637,
'ppid': 3847,
'status': 'S',
'time_since_update': 1,
'username': 'nicolargo'}]
Get a specific field:
# curl http://localhost:61208/api/3/processlist/pid
{'pid': [239588,
5637,
5755,
5895,
239766,
5946,
4092,
281859,
239606,
238929,
238897,
207471,
239618,
375431,
391948,
238993,
5798,
391799,
178587,
3336,
2259,
360036,
3934,
396420,
239023,
374111,
3913,
18486,
270468,
4121,
3855,
211213,
68322,
390101,
227849,
348,
2430,
4181,
238947,
6053,
150281,
390100,
3853,
4928,
4241,
4374,
4265,
1139,
1,
4266,
4261,
237994,
4152,
373165,
138395,
4143,
1180,
4287,
1158,
1285,
373164,
4196,
396360,
4116,
4264,
3847,
4164,
238900,
4274,
3890,
2216,
3764,
4284,
4123,
238901,
4078,
255840,
4267,
1575,
2208,
3863,
1300,
344713,
1354,
1008,
1121,
172714,
396199,
1138,
1153,
4262,
4129,
4340,
4279,
4332,
3959,
2394,
3858,
3908,
4263,
4339,
1176,
4343,
5587,
3896,
4252,
4276,
4281,
3932,
3921,
1181,
3927,
4137,
4273,
3902,
1324,
5573,
4160,
239661,
4048,
4120,
2406,
3868,
18537,
1178,
4272,
1173,
4057,
4260,
4285,
1147,
1166,
67406,
3883,
1130,
207437,
1150,
37983,
4062,
1010,
4072,
37989,
1182,
1129,
344711,
1007,
37992,
4141,
187870,
1135,
6521,
396404,
2403,
3339,
1451,
1209,
1163,
138445,
2230,
213050,
37995,
344710,
2404,
4601,
1122,
396419,
2229,
2035,
238903,
3848,
997,
375,
1335,
2235,
1214,
4029,
213333,
1132,
2,
3,
4,
6,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
21,
22,
23,
24,
27,
28,
29,
30,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
89,
90,
91,
94,
95,
97,
98,
99,
100,
102,
103,
105,
106,
107,
110,
119,
136,
187,
189,
190,
191,
192,
193,
194,
195,
196,
202,
203,
204,
207,
208,
237,
279,
280,
288,
289,
291,
359,
364,
398,
399,
400,
424,
425,
426,
431,
465,
495,
502,
765,
766,
767,
768,
774,
775,
776,
777,
778,
779,
780,
781,
904,
915,
928,
932,
939,
947,
958,
1347,
1432,
1433,
1434,
1435,
1436,
1437,
1438,
1440,
2301,
2325,
3909,
24555,
24771,
25388,
57294,
57650,
57855,
86491,
86492,
86504,
86505,
86506,
86507,
86508,
86509,
125413,
126036,
210727,
210918,
211155,
211634,
211932,
212663,
217976,
264756,
354417,
358559,
378648,
378848,
379044,
379176,
379506,
382462,
389912,
389957,
389975,
390957,
391483,
392032,
392469,
392694,
392871,
394604,
394716,
395296,
395988,
396037]}
Get a specific item when field matchs the given value:
# curl http://localhost:61208/api/3/processlist/pid/239588
{'239588': [{'cmdline': ['/usr/share/code/code',
'--type=renderer',
'--disable-color-correct-rendering',
'--field-trial-handle=9801772374554752705,8463974869748304130,131072',
'--disable-features=CookiesWithoutSameSiteMustBeSecure,SameSiteByDefaultCookies,SpareRendererForSitePerProcess',
'--lang=en-US',
'--enable-crash-reporter=7c06f526-63e8-47aa-8c08-b95f6ad2ec2d,no_channel',
'--global-crash-keys=7c06f526-63e8-47aa-8c08-b95f6ad2ec2d,no_channel,_companyName=Microsoft,_productName=VSCode,_version=1.59.1',
'--user-data-dir=/home/nicolargo/.config/Code',
'--standard-schemes=vscode-webview,vscode-file',
'--secure-schemes=vscode-webview,vscode-file',
'--bypasscsp-schemes',
'--cors-schemes=vscode-webview,vscode-file',
'--fetch-schemes=vscode-webview,vscode-file',
'--service-worker-schemes=vscode-webview',
'--streaming-schemes',
'--app-path=/usr/share/code/resources/app',
'--no-sandbox',
'--no-zygote',
'--num-raster-threads=2',
'--enable-main-frame-before-activation',
'--renderer-client-id=9',
'--no-v8-untrusted-code-mitigations',
'--shared-files=v8_context_snapshot_data:100',
'--vscode-window-config=vscode:662562c7-385c-48ce-8810-0faf0271b42a'],
'cpu_percent': 0.0,
'cpu_times': [2564.47, 206.42, 7.67, 1.78, 1.73],
'gids': [1000, 1000, 1000],
'io_counters': [360050688, 18534400, 0, 0, 0],
'key': 'pid',
'memory_info': [936550400,
54797201408,
102572032,
125108224,
0,
1184972800,
0],
'memory_percent': 11.932065763346927,
'name': 'code',
'nice': 0,
'num_threads': 20,
'pid': 239588,
'ppid': 238897,
'status': 'S',
'time_since_update': 1,
'username': 'nicolargo'}]}
GET quicklook¶
Get plugin stats:
# curl http://localhost:61208/api/3/quicklook
{'cpu': 23.7,
'cpu_hz': 3000000000.0,
'cpu_hz_current': 1637913250.0,
'cpu_name': 'Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz',
'mem': 78.0,
'percpu': [{'cpu_number': 0,
'guest': 0.0,
'guest_nice': 0.0,
'idle': 75.2,
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 12.8,
'steal': 0.0,
'system': 1.6,
'total': 24.8,
'user': 10.4},
{'cpu_number': 1,
'guest': 0.0,
'guest_nice': 0.0,
'idle': 74.1,
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 5.2,
'steal': 0.0,
'system': 0.9,
'total': 25.9,
'user': 19.8},
{'cpu_number': 2,
'guest': 0.0,
'guest_nice': 0.0,
'idle': 94.5,
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 1.8,
'steal': 0.0,
'system': 0.9,
'total': 5.5,
'user': 2.7},
{'cpu_number': 3,
'guest': 0.0,
'guest_nice': 0.0,
'idle': 61.7,
'iowait': 0.0,
'irq': 0.0,
'key': 'cpu_number',
'nice': 0.0,
'softirq': 0.0,
'steal': 0.0,
'system': 0.0,
'total': 38.3,
'user': 38.3}],
'swap': 24.2}
Get a specific field:
# curl http://localhost:61208/api/3/quicklook/cpu
{'cpu': 23.7}
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 20.04 64bit',
'linux_distro': 'Ubuntu 20.04',
'os_name': 'Linux',
'os_version': '5.4.0-77-generic',
'platform': '64bit'}
Get a specific field:
# curl http://localhost:61208/api/3/system/os_name
{'os_name': 'Linux'}
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': [['2021-11-22T11:53:15.027569', 1.7],
['2021-11-22T11:53:16.073520', 1.7],
['2021-11-22T11:53:17.170643', 1.8]],
'user': [['2021-11-22T11:53:15.027563', 15.3],
['2021-11-22T11:53:16.073516', 15.3],
['2021-11-22T11:53:17.170638', 3.5]]}
Limit history to last 2 values:
# curl http://localhost:61208/api/3/cpu/history/2
{'system': [['2021-11-22T11:53:16.073520', 1.7],
['2021-11-22T11:53:17.170643', 1.8]],
'user': [['2021-11-22T11:53:16.073516', 15.3],
['2021-11-22T11:53:17.170638', 3.5]]}
History for a specific field:
# curl http://localhost:61208/api/3/cpu/system/history
{'system': [['2021-11-22T11:53:15.027569', 1.7],
['2021-11-22T11:53:16.073520', 1.7],
['2021-11-22T11:53:17.170643', 1.8]]}
Limit history for a specific field to last 2 values:
# curl http://localhost:61208/api/3/cpu/system/history
{'system': [['2021-11-22T11:53:16.073520', 1.7],
['2021-11-22T11:53:17.170643', 1.8]]}
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},
'connections': {'connections_disable': ['True'],
'connections_nf_conntrack_percent_careful': 70.0,
'connections_nf_conntrack_percent_critical': 90.0,
'connections_nf_conntrack_percent_warning': 80.0,
'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_disable': ['False']},
'irq': {'history_size': 3600.0, 'irq_disable': ['True']},
'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},
'raid': {'history_size': 3600.0, 'raid_disable': ['True']},
'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},
'smart': {'history_size': 3600.0, 'smart_disable': ['True']},
'system': {'history_size': 3600.0,
'system_disable': ['False'],
'system_refresh': 60},
'uptime': {'history_size': 3600.0},
'wifi': {'history_size': 3600.0,
'wifi_careful': -65.0,
'wifi_critical': -85.0,
'wifi_disable': ['True'],
'wifi_hide': ['lo', 'docker.*'],
'wifi_warning': -75.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}