mirror of
https://github.com/nicolargo/glances.git
synced 2024-09-20 00:58:03 +03:00
144 lines
2.9 KiB
ReStructuredText
144 lines
2.9 KiB
ReStructuredText
.. _api:
|
|
|
|
API (Restfull/JSON) documentation
|
|
=================================
|
|
|
|
The Glances Restfull/API server could be ran using the following command line:
|
|
|
|
.. code-block:: bash
|
|
|
|
# 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",
|
|
"containers",
|
|
"core",
|
|
"cpu",
|
|
"diskio",
|
|
"folders",
|
|
"fs",
|
|
"gpu",
|
|
"help",
|
|
"ip",
|
|
"irq",
|
|
"load",
|
|
"mem",
|
|
"memswap",
|
|
"network",
|
|
"now",
|
|
"percpu",
|
|
"ports",
|
|
"processcount",
|
|
"processlist",
|
|
"psutilversion",
|
|
"quicklook",
|
|
"raid",
|
|
"sensors",
|
|
"smart",
|
|
"system",
|
|
"uptime",
|
|
"wifi"]
|
|
|
|
GET alert
|
|
---------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/alert
|
|
[[1683529666.0,
|
|
-1,
|
|
"WARNING",
|
|
"MEM",
|
|
72.14659297257798,
|
|
72.14659297257798,
|
|
72.14659297257798,
|
|
72.14659297257798,
|
|
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": 1.4009511470794678},
|
|
{"count": 0,
|
|
"countmax": 20.0,
|
|
"countmin": None,
|
|
"key": "name",
|
|
"name": "Python",
|
|
"refresh": 3.0,
|
|
"regex": True,
|
|
"result": None,
|
|
"timer": 1.4008433818817139}]
|
|
|
|
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.4009511470794678}]}
|
|
|
|
GET connections
|
|
---------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/connections
|
|
{"net_connections_enabled": True, "nf_conntrack_enabled": True}
|
|
|
|
Get a specific field::
|
|
|
|
# curl http://localhost:61208/api/3/connections/net_connections_enabled
|
|
{"net_connections_enabled": True}
|
|
|
|
GET containers
|
|
--------------
|
|
|
|
Get plugin stats::
|
|
|
|
# curl http://localhost:61208/api/3/containers
|