summaryrefslogtreecommitdiffstats
path: root/docs/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst701
1 files changed, 423 insertions, 278 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 3077e418..bf15a090 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -141,7 +141,7 @@ Get plugin stats::
"refresh": 3.0,
"regex": True,
"result": None,
- "timer": 0.4279599189758301},
+ "timer": 0.3478415012359619},
{"count": 0,
"countmax": 20.0,
"countmin": None,
@@ -150,7 +150,7 @@ Get plugin stats::
"refresh": 3.0,
"regex": True,
"result": None,
- "timer": 0.4277961254119873}]
+ "timer": 0.3477509021759033}]
Fields descriptions:
@@ -178,7 +178,7 @@ Get a specific item when field matches the given value::
"refresh": 3.0,
"regex": True,
"result": None,
- "timer": 0.4279599189758301}]}
+ "timer": 0.3478415012359619}]}
GET cloud
---------
@@ -219,25 +219,7 @@ GET containers
Get plugin stats::
# curl http://localhost:61208/api/4/containers
- [{"command": "/portainer",
- "cpu": {"total": 0.0},
- "cpu_percent": 0.0,
- "created": "2022-10-29T14:59:10.266701439Z",
- "engine": "docker",
- "id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb",
- "image": ["portainer/portainer-ce:2.9.3"],
- "io": {"cumulative_ior": 589824, "cumulative_iow": 1646592},
- "key": "name",
- "memory": {"cache": None,
- "limit": 7823568896,
- "max_usage": None,
- "rss": None,
- "usage": 18767872},
- "memory_usage": 18767872,
- "name": "portainer",
- "network": {"cumulative_rx": 4041422, "cumulative_tx": 2406},
- "status": "running",
- "uptime": "1 weeks"}]
+ []
Fields descriptions:
@@ -258,41 +240,13 @@ Fields descriptions:
* **pod_name**: Pod name (only with Podman) (unit is *None*)
* **pod_id**: Pod ID (only with Podman) (unit is *None*)
-Get a specific field::
-
- # curl http://localhost:61208/api/4/containers/name
- {"name": ["portainer"]}
-
-Get a specific item when field matches the given value::
-
- # curl http://localhost:61208/api/4/containers/name/portainer
- {"portainer": [{"command": "/portainer",
- "cpu": {"total": 0.0},
- "cpu_percent": 0.0,
- "created": "2022-10-29T14:59:10.266701439Z",
- "engine": "docker",
- "id": "3abd51c615968482d9ccff5afc629f267f6dda113ed68b75b432615fae3b49fb",
- "image": ["portainer/portainer-ce:2.9.3"],
- "io": {"cumulative_ior": 589824, "cumulative_iow": 1646592},
- "key": "name",
- "memory": {"cache": None,
- "limit": 7823568896,
- "max_usage": None,
- "rss": None,
- "usage": 18767872},
- "memory_usage": 18767872,
- "name": "portainer",
- "network": {"cumulative_rx": 4041422, "cumulative_tx": 2406},
- "status": "running",
- "uptime": "1 weeks"}]}
-
GET core
--------
Get plugin stats::
# curl http://localhost:61208/api/4/core
- {"log": 4, "phys": 2}
+ {"log": 16, "phys": 10}
Fields descriptions:
@@ -302,7 +256,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/core/phys
- {"phys": 2}
+ {"phys": 10}
GET cpu
-------
@@ -310,20 +264,20 @@ GET cpu
Get plugin stats::
# curl http://localhost:61208/api/4/cpu
- {"cpucore": 4,
- "ctx_switches": 1279914863,
+ {"cpucore": 16,
+ "ctx_switches": 308044421,
"guest": 0.0,
- "idle": 72.8,
- "interrupts": 572348639,
- "iowait": 0.3,
+ "idle": 1.0,
+ "interrupts": 272946404,
+ "iowait": 0.0,
"irq": 0.0,
"nice": 0.0,
- "soft_interrupts": 267434589,
+ "soft_interrupts": 94947380,
"steal": 0.0,
"syscalls": 0,
- "system": 3.7,
- "total": 26.9,
- "user": 23.3}
+ "system": 0.0,
+ "total": 0.0,
+ "user": 0.0}
Fields descriptions:
@@ -356,7 +310,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/cpu/total
- {"total": 26.9}
+ {"total": 0.0}
GET diskio
----------
@@ -364,18 +318,18 @@ GET diskio
Get plugin stats::
# curl http://localhost:61208/api/4/diskio
- [{"disk_name": "sda",
+ [{"disk_name": "nvme0n1",
"key": "disk_name",
- "read_bytes": 119365034496,
- "read_count": 6509308,
- "write_bytes": 252726218752,
- "write_count": 3065941},
- {"disk_name": "sda1",
+ "read_bytes": 5076893184,
+ "read_count": 211280,
+ "write_bytes": 16891180032,
+ "write_count": 974804},
+ {"disk_name": "nvme0n1p1",
"key": "disk_name",
- "read_bytes": 24433664,
- "read_count": 675,
- "write_bytes": 0,
- "write_count": 52}]
+ "read_bytes": 8103936,
+ "read_count": 815,
+ "write_bytes": 1024,
+ "write_count": 2}]
Fields descriptions:
@@ -397,17 +351,22 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/diskio/disk_name
- {"disk_name": ["sda", "sda1", "sda2", "sda5", "dm-0", "dm-1"]}
+ {"disk_name": ["nvme0n1",
+ "nvme0n1p1",
+ "nvme0n1p2",
+ "nvme0n1p3",
+ "dm-0",
+ "dm-1"]}
Get a specific item when field matches the given value::
- # curl http://localhost:61208/api/4/diskio/disk_name/sda
- {"sda": [{"disk_name": "sda",
- "key": "disk_name",
- "read_bytes": 119365034496,
- "read_count": 6509308,
- "write_bytes": 252726218752,
- "write_count": 3065941}]}
+ # curl http://localhost:61208/api/4/diskio/disk_name/nvme0n1
+ {"nvme0n1": [{"disk_name": "nvme0n1",
+ "key": "disk_name",
+ "read_bytes": 5076893184,
+ "read_count": 211280,
+ "write_bytes": 16891180032,
+ "write_count": 974804}]}
GET folders
-----------
@@ -433,22 +392,14 @@ GET fs
Get plugin stats::
# curl http://localhost:61208/api/4/fs
- [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
- "free": 35493531648,
+ [{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
+ "free": 904218632192,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
- "percent": 84.6,
- "size": 243334156288,
- "used": 195453169664},
- {"device_name": "zsfpool",
- "free": 31195136,
- "fs_type": "zfs",
- "key": "mnt_point",
- "mnt_point": "/zsfpool",
- "percent": 25.4,
- "size": 41811968,
- "used": 10616832}]
+ "percent": 5.1,
+ "size": 1003736440832,
+ "used": 48455303168}]
Fields descriptions:
@@ -463,19 +414,19 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/fs/mnt_point
- {"mnt_point": ["/", "/zsfpool", "/var/snap/firefox/common/host-hunspell"]}
+ {"mnt_point": ["/"]}
Get a specific item when field matches the given value::
# curl http://localhost:61208/api/4/fs/mnt_point//
- {"/": [{"device_name": "/dev/mapper/ubuntu--gnome--vg-root",
- "free": 35493531648,
+ {"/": [{"device_name": "/dev/mapper/ubuntu--vg-ubuntu--lv",
+ "free": 904218632192,
"fs_type": "ext4",
"key": "mnt_point",
"mnt_point": "/",
- "percent": 84.6,
- "size": 243334156288,
- "used": 195453169664}]}
+ "percent": 5.1,
+ "size": 1003736440832,
+ "used": 48455303168}]}
GET gpu
-------
@@ -508,11 +459,11 @@ GET ip
Get plugin stats::
# curl http://localhost:61208/api/4/ip
- {"address": "192.168.172.139",
- "gateway": "192.168.172.240",
+ {"address": "192.168.1.26",
+ "gateway": "192.168.1.1",
"mask": "255.255.255.0",
"mask_cidr": 24,
- "public_address": "92.184.102.172",
+ "public_address": "",
"public_info_human": ""}
Fields descriptions:
@@ -527,7 +478,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/ip/gateway
- {"gateway": "192.168.172.240"}
+ {"gateway": "192.168.1.1"}
GET irq
-------
@@ -548,7 +499,10 @@ GET load
Get plugin stats::
# curl http://localhost:61208/api/4/load
- {"cpucore": 4, "min1": 1.41845703125, "min15": 1.12744140625, "min5": 1.25}
+ {"cpucore": 16,
+ "min1": 1.04150390625,
+ "min15": 0.9111328125,
+ "min5": 1.05859375}
Fields descriptions:
@@ -560,7 +514,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/load/min1
- {"min1": 1.41845703125}
+ {"min1": 1.04150390625}
GET mem
-------
@@ -568,16 +522,16 @@ GET mem
Get plugin stats::
# curl http://localhost:61208/api/4/mem
- {"active": 2872311808,
- "available": 2107265024,
- "buffers": 81784832,
- "cached": 2386653184,
- "free": 2107265024,
- "inactive": 3126542336,
- "percent": 73.1,
- "shared": 662663168,
- "total": 7823568896,
- "used": 5716303872}
+ {"active": 8740761600,
+ "available": 7811407872,
+ "buffers": 431038464,
+ "cached": 7773085696,
+ "free": 7811407872,
+ "inactive": 4876947456,
+ "percent": 52.4,
+ "shared": 893501440,
+ "total": 16422486016,
+ "used": 8611078144}
Fields descriptions:
@@ -596,7 +550,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/mem/total
- {"total": 7823568896}
+ {"total": 16422486016}
GET memswap
-----------
@@ -604,13 +558,13 @@ GET memswap
Get plugin stats::
# curl http://localhost:61208/api/4/memswap
- {"free": 4571234304,
- "percent": 43.4,
- "sin": 9645510656,
- "sout": 20458577920,
+ {"free": 4293652480,
+ "percent": 0.0,
+ "sin": 0,
+ "sout": 118784,
"time_since_update": 1,
- "total": 8082419712,
- "used": 3511185408}
+ "total": 4294963200,
+ "used": 1310720}
Fields descriptions:
@@ -625,7 +579,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/memswap/total
- {"total": 8082419712}
+ {"total": 4294963200}
GET network
-----------
@@ -635,26 +589,15 @@ Get plugin stats::
# curl http://localhost:61208/api/4/network
[{"alias": None,
"bytes_all": 0,
- "bytes_all_gauge": 11769774846,
+ "bytes_all_gauge": 2577813495,
"bytes_recv": 0,
- "bytes_recv_gauge": 11031650851,
+ "bytes_recv_gauge": 2223235128,
"bytes_sent": 0,
- "bytes_sent_gauge": 738123995,
- "interface_name": "wlp2s0",
+ "bytes_sent_gauge": 354578367,
+ "interface_name": "wlp0s20f3",
"key": "interface_name",
"speed": 0,
- "time_since_update": 0.3296170234680176},
- {"alias": None,
- "bytes_all": 0,
- "bytes_all_gauge": 0,
- "bytes_recv": 0,
- "bytes_recv_gauge": 0,
- "bytes_sent": 0,
- "bytes_sent_gauge": 0,
- "interface_name": "br-40875d2e2716",
- "key": "interface_name",
- "speed": 0,
- "time_since_update": 0.3296170234680176}]
+ "time_since_update": 0.35242390632629395}]
Fields descriptions:
@@ -676,29 +619,22 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/network/interface_name
- {"interface_name": ["wlp2s0",
- "br-40875d2e2716",
- "br_grafana",
- "lxdbr0",
- "veth05608da0",
- "mpqemubr0",
- "veth601e59cb",
- "vethfd301c0"]}
+ {"interface_name": ["wlp0s20f3"]}
Get a specific item when field matches the given value::
- # curl http://localhost:61208/api/4/network/interface_name/wlp2s0
- {"wlp2s0": [{"alias": None,
- "bytes_all": 0,
- "bytes_all_gauge": 11769774846,
- "bytes_recv": 0,
- "bytes_recv_gauge": 11031650851,
- "bytes_sent": 0,
- "bytes_sent_gauge": 738123995,
- "interface_name": "wlp2s0",
- "key": "interface_name",
- "speed": 0,
- "time_since_update": 0.3296170234680176}]}
+ # curl http://localhost:61208/api/4/network/interface_name/wlp0s20f3
+ {"wlp0s20f3": [{"alias": None,
+ "bytes_all": 0,
+ "bytes_all_gauge": 2577813495,
+ "bytes_recv": 0,
+ "bytes_recv_gauge": 2223235128,
+ "bytes_sent": 0,
+ "bytes_sent_gauge": 354578367,
+ "interface_name": "wlp0s20f3",
+ "key": "interface_name",
+ "speed": 0,
+ "time_since_update": 0.35242390632629395}]}
GET now
-------
@@ -706,7 +642,17 @@ GET now
Get plugin stats::
# curl http://localhost:61208/api/4/now
- "2024-04-07 18:19:47 CEST"
+ {"custom": "2024-05-28 13:29:16 CEST", "iso": "2024-05-28T13:29:16+02:00"}
+
+Fields descriptions:
+
+* **custom**: Current date in custom format (unit is *None*)
+* **iso**: Current date in ISO 8601 format (unit is *None*)
+
+Get a specific field::
+
+ # curl http://localhost:61208/api/4/now/iso
+ {"iso": "2024-05-28T13:29:16+02:00"}
GET percpu
----------
@@ -717,29 +663,29 @@ Get plugin stats::
[{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
- "idle": 52.0,
- "iowait": 1.0,
+ "idle": 1.0,
+ "iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
- "system": 4.0,
- "total": 48.0,
- "user": 21.0},
+ "system": 0.0,
+ "total": 99.0,
+ "user": 0.0},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
- "idle": 71.0,
+ "idle": 0.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
- "system": 1.0,
- "total": 29.0,
- "user": 4.0}]
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0}]
Fields descriptions:
@@ -759,7 +705,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/percpu/cpu_number
- {"cpu_number": [0, 1, 2, 3]}
+ {"cpu_number": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]}
GET ports
---------
@@ -768,13 +714,12 @@ Get plugin stats::
# curl http://localhost:61208/api/4/ports
[{"description": "DefaultGateway",
- "host": "192.168.172.240",
+ "host": "192.168.1.1",
"indice": "port_0",
- "key": "indice",
"port": 0,
"refresh": 30,
"rtt_warning": None,
- "status": 0.007383,
+ "status": 0.00586,
"timeout": 3}]
Fields descriptions:
@@ -790,21 +735,20 @@ Fields descriptions:
Get a specific field::
- # curl http://localhost:61208/api/4/ports/indice
- {"indice": ["port_0"]}
+ # curl http://localhost:61208/api/4/ports/host
+ {"host": ["192.168.1.1"]}
Get a specific item when field matches the given value::
- # curl http://localhost:61208/api/4/ports/indice/port_0
- {"port_0": [{"description": "DefaultGateway",
- "host": "192.168.172.240",
- "indice": "port_0",
- "key": "indice",
- "port": 0,
- "refresh": 30,
- "rtt_warning": None,
- "status": 0.007383,
- "timeout": 3}]}
+ # 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,
+ "status": 0.00586,
+ "timeout": 3}]}
GET processcount
----------------
@@ -812,7 +756,7 @@ GET processcount
Get plugin stats::
# curl http://localhost:61208/api/4/processcount
- {"pid_max": 0, "running": 1, "sleeping": 339, "thread": 1665, "total": 407}
+ {"pid_max": 0, "running": 0, "sleeping": 292, "thread": 1700, "total": 423}
Fields descriptions:
@@ -825,7 +769,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/processcount/total
- {"total": 407}
+ {"total": 423}
GET processlist
---------------
@@ -865,67 +809,223 @@ GET quicklook
Get plugin stats::
# curl http://localhost:61208/api/4/quicklook
- {"cpu": 26.9,
- "cpu_hz": 2025000000.0,
- "cpu_hz_current": 1718239250.0,
- "cpu_log_core": 4,
- "cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
- "cpu_phys_core": 2,
- "load": 28.2,
- "mem": 73.1,
+ {"cpu": 0.0,
+ "cpu_hz": 4475000000.0,
+ "cpu_hz_current": 1293040187.4999998,
+ "cpu_log_core": 16,
+ "cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H",
+ "cpu_phys_core": 10,
+ "load": 5.7,
+ "mem": 52.4,
"percpu": [{"cpu_number": 0,
"guest": 0.0,
"guest_nice": 0.0,
- "idle": 52.0,
- "iowait": 1.0,
+ "idle": 1.0,
+ "iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
- "system": 4.0,
- "total": 48.0,
- "user": 21.0},
+ "system": 0.0,
+ "total": 99.0,
+ "user": 0.0},
{"cpu_number": 1,
"guest": 0.0,
"guest_nice": 0.0,
- "idle": 71.0,
+ "idle": 0.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
- "system": 1.0,
- "total": 29.0,
- "user": 4.0},
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
{"cpu_number": 2,
"guest": 0.0,
"guest_nice": 0.0,
- "idle": 43.0,
+ "idle": 0.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
- "system": 4.0,
- "total": 57.0,
- "user": 31.0},
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
{"cpu_number": 3,
"guest": 0.0,
"guest_nice": 0.0,
- "idle": 62.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 4,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
"iowait": 0.0,
"irq": 0.0,
"key": "cpu_number",
"nice": 0.0,
"softirq": 0.0,
"steal": 0.0,
- "system": 2.0,
- "total": 38.0,
- "user": 14.0}],
- "swap": 43.4}
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 5,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 6,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 7,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 8,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 9,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 1.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 99.0,
+ "user": 0.0},
+ {"cpu_number": 10,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 11,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 12,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 13,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 14,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0},
+ {"cpu_number": 15,
+ "guest": 0.0,
+ "guest_nice": 0.0,
+ "idle": 0.0,
+ "iowait": 0.0,
+ "irq": 0.0,
+ "key": "cpu_number",
+ "nice": 0.0,
+ "softirq": 0.0,
+ "steal": 0.0,
+ "system": 0.0,
+ "total": 100.0,
+ "user": 0.0}],
+ "swap": 0.0}
Fields descriptions:
@@ -942,7 +1042,7 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/quicklook/cpu_name
- {"cpu_name": "Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz"}
+ {"cpu_name": "13th Gen Intel(R) Core(TM) i7-13620H"}
GET raid
--------
@@ -958,20 +1058,20 @@ GET sensors
Get plugin stats::
# curl http://localhost:61208/api/4/sensors
- [{"critical": 105,
+ [{"critical": None,
"key": "label",
- "label": "acpitz 0",
+ "label": "Ambient",
"type": "temperature_core",
"unit": "C",
- "value": 27,
- "warning": 105},
- {"critical": 105,
+ "value": 34,
+ "warning": 0},
+ {"critical": None,
"key": "label",
- "label": "acpitz 1",
+ "label": "Ambient 3",
"type": "temperature_core",
"unit": "C",
"value": 29,
- "warning": 105}]
+ "warning": 0}]
Fields descriptions:
@@ -985,26 +1085,54 @@ Fields descriptions:
Get a specific field::
# curl http://localhost:61208/api/4/sensors/label
- {"label": ["acpitz 0",
- "acpitz 1",
- "Package id 0",
- "Core 0",
- "Core 1",
+ {"label": ["Ambient",
+ "Ambient 3",
+ "Ambient 5",
+ "Ambient 6",
"CPU",
- "Ambient",
+ "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",
+ "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",
"BAT BAT0"]}
Get a specific item when field matches the given value::
- # curl http://localhost:61208/api/4/sensors/label/acpitz 0
- {"acpitz 0": [{"critical": 105,
- "key": "label",
- "label": "acpitz 0",
- "type": "temperature_core",
- "unit": "C",
- "value": 27,
- "warning": 105}]}
+ # 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}]}
GET smart
---------
@@ -1020,11 +1148,11 @@ GET system
Get plugin stats::
# curl http://localhost:61208/api/4/system
- {"hostname": "XPS13-9333",
- "hr_name": "Ubuntu 22.04 64bit / Linux 5.15.0-94-generic",
- "linux_distro": "Ubuntu 22.04",
+ {"hostname": "nicolargo-xps15",
+ "hr_name": "Ubuntu 24.04 64bit / Linux 6.8.0-31-generic",
+ "linux_distro": "Ubuntu 24.04",
"os_name": "Linux",
- "os_version": "5.15.0-94-generic",
+ "os_version": "6.8.0-31-generic",
"platform": "64bit"}
Fields descriptions:
@@ -1047,7 +1175,7 @@ GET uptime
Get plugin stats::
# curl http://localhost:61208/api/4/uptime
- "34 days, 9:18:57"
+ "14 days, 14:21:53"
GET version
-----------
@@ -1055,7 +1183,7 @@ GET version
Get plugin stats::
# curl http://localhost:61208/api/4/version
- "4.0.0_beta01"
+ "4.1.0_beta01"
GET wifi
--------
@@ -1063,7 +1191,23 @@ GET wifi
Get plugin stats::
# curl http://localhost:61208/api/4/wifi
- []
+ [{"key": "ssid",
+ "quality_level": -61.0,
+ "quality_link": 49.0,
+ "ssid": "wlp0s20f3"}]
+
+Get a specific field::
+
+ # curl http://localhost:61208/api/4/wifi/ssid
+ {"ssid": ["wlp0s20f3"]}
+
+Get a specific item when field matches the given value::
+
+ # curl http://localhost:61208/api/4/wifi/ssid/wlp0s20f3
+ {"wlp0s20f3": [{"key": "ssid",
+ "quality_level": -61.0,
+ "quality_link": 49.0,
+ "ssid": "wlp0s20f3"}]}
GET all stats
-------------
@@ -1107,34 +1251,34 @@ GET stats history
History of a plugin::
# curl http://localhost:61208/api/4/cpu/history
- {"system": [["2024-04-07T18:19:49.863788", 3.2],
- ["2024-04-07T18:19:50.897946", 3.2],
- ["2024-04-07T18:19:52.129196", 2.6]],
- "user": [["2024-04-07T18:19:49.863779", 17.0],
- ["2024-04-07T18:19:50.897925", 17.0],
- ["2024-04-07T18:19:52.129189", 6.9]]}
+ {"system": [["2024-05-28T13:29:18.134731", 0.0],
+ ["2024-05-28T13:29:19.167225", 0.0],
+ ["2024-05-28T13:29:20.241827", 0.0]],
+ "user": [["2024-05-28T13:29:18.134716", 0.0],
+ ["2024-05-28T13:29:19.167219", 2.0],
+ ["2024-05-28T13:29:20.241811", 2.0]]}
Limit history to last 2 values::
# curl http://localhost:61208/api/4/cpu/history/2
- {"system": [["2024-04-07T18:19:50.897946", 3.2],
- ["2024-04-07T18:19:52.129196", 2.6]],
- "user": [["2024-04-07T18:19:50.897925", 17.0],
- ["2024-04-07T18:19:52.129189", 6.9]]}
+ {"system": [["2024-05-28T13:29:19.167225", 0.0],
+ ["2024-05-28T13:29:20.241827", 0.0]],
+ "user": [["2024-05-28T13:29:19.167219", 2.0],
+ ["2024-05-28T13:29:20.241811", 2.0]]}
History for a specific field::
# curl http://localhost:61208/api/4/cpu/system/history
- {"system": [["2024-04-07T18:19:47.585137", 3.7],
- ["2024-04-07T18:19:49.863788", 3.2],
- ["2024-04-07T18:19:50.897946", 3.2],
- ["2024-04-07T18:19:52.129196", 2.6]]}
+ {"system": [["2024-05-28T13:29:16.956417", 0.0],
+ ["2024-05-28T13:29:18.134731", 0.0],
+ ["2024-05-28T13:29:19.167225", 0.0],
+ ["2024-05-28T13:29:20.241827", 0.0]]}
Limit history for a specific field to last 2 values::
# curl http://localhost:61208/api/4/cpu/system/history
- {"system": [["2024-04-07T18:19:50.897946", 3.2],
- ["2024-04-07T18:19:52.129196", 2.6]]}
+ {"system": [["2024-05-28T13:29:19.167225", 0.0],
+ ["2024-05-28T13:29:20.241827", 0.0]]}
GET limits (used for thresholds)
--------------------------------
@@ -1149,13 +1293,13 @@ All limits/thresholds::
"containers_max_name_size": 20.0,
"history_size": 1200.0},
"core": {"history_size": 1200.0},
- "cpu": {"cpu_ctx_switches_careful": 160000.0,
- "cpu_ctx_switches_critical": 200000.0,
- "cpu_ctx_switches_warning": 180000.0,
+ "cpu": {"cpu_ctx_switches_careful": 640000.0,
+ "cpu_ctx_switches_critical": 800000.0,
+ "cpu_ctx_switches_warning": 720000.0,
"cpu_disable": ["False"],
- "cpu_iowait_careful": 20.0,
- "cpu_iowait_critical": 25.0,
- "cpu_iowait_warning": 22.5,
+ "cpu_iowait_careful": 5.0,
+ "cpu_iowait_critical": 6.25,
+ "cpu_iowait_warning": 5.625,
"cpu_steal_careful": 50.0,
"cpu_steal_critical": 90.0,
"cpu_steal_warning": 70.0,
@@ -1179,7 +1323,7 @@ Al