Files
glances/docs/api/openapi.json
2025-11-22 18:48:13 +01:00

924 lines
27 KiB
JSON

{
"openapi": "3.0.2",
"info": { "title": "FastAPI", "version": "0.1.0" },
"paths": {
"/api/4/status": {
"get": {
"summary": " Api Status",
"description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\nThis entry point should be used to check the API health.\n\nSee related issue: Web server health check endpoint #1988",
"operationId": "_api_status_api_4_status_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
},
"head": {
"summary": " Api Status",
"description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\nThis entry point should be used to check the API health.\n\nSee related issue: Web server health check endpoint #1988",
"operationId": "_api_status_api_4_status_head",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/events/clear/warning": {
"post": {
"summary": " Events Clear Warning",
"description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\n\nIt's a post message to clean warning events",
"operationId": "_events_clear_warning_api_4_events_clear_warning_post",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/events/clear/all": {
"post": {
"summary": " Events Clear All",
"description": "Glances API RESTful implementation.\n\nReturn a 200 status code.\n\nIt's a post message to clean all events",
"operationId": "_events_clear_all_api_4_events_clear_all_post",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/processes/extended/disable": {
"post": {
"summary": " Api Disable Extended Processes",
"description": "Glances API RESTful implementation.\n\nDisable extended process stats\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error",
"operationId": "_api_disable_extended_processes_api_4_processes_extended_disable_post",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/processes/extended/{pid}": {
"post": {
"summary": " Api Set Extended Processes",
"description": "Glances API RESTful implementation.\n\nSet the extended process stats for the given PID\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error",
"operationId": "_api_set_extended_processes_api_4_processes_extended__pid__post",
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Pid" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/config": {
"get": {
"summary": " Api Config",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration file\nHTTP/200 if OK\nHTTP/404 if others error",
"operationId": "_api_config_api_4_config_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/config/{section}": {
"get": {
"summary": " Api Config Section",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration section\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error",
"operationId": "_api_config_section_api_4_config__section__get",
"parameters": [
{
"name": "section",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Section" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/config/{section}/{item}": {
"get": {
"summary": " Api Config Section Item",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances configuration section/item\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error",
"operationId": "_api_config_section_item_api_4_config__section___item__get",
"parameters": [
{
"name": "section",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Section" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/args": {
"get": {
"summary": " Api Args",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances command line arguments\nHTTP/200 if OK\nHTTP/404 if others error",
"operationId": "_api_args_api_4_args_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/args/{item}": {
"get": {
"summary": " Api Args Item",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the Glances command line arguments item\nHTTP/200 if OK\nHTTP/400 if item is not found\nHTTP/404 if others error",
"operationId": "_api_args_item_api_4_args__item__get",
"parameters": [
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/help": {
"get": {
"summary": " Api Help",
"description": "Glances API RESTful implementation.\n\nReturn the help data or 404 error.",
"operationId": "_api_help_api_4_help_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/all": {
"get": {
"summary": " Api All",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_all_api_4_all_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/all/limits": {
"get": {
"summary": " Api All Limits",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins limits\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_all_limits_api_4_all_limits_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/all/views": {
"get": {
"summary": " Api All Views",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of all the plugins views\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_all_views_api_4_all_views_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/pluginslist": {
"get": {
"summary": " Api Plugins",
"description": "Glances API RESTFul implementation.\n\n@api {get} /api/%s/pluginslist Get plugins list\n@apiVersion 2.0\n@apiName pluginslist\n@apiGroup plugin\n\n@apiSuccess {String[]} Plugins list.\n\n@apiSuccessExample Success-Response:\n HTTP/1.1 200 OK\n [\n \"load\",\n \"help\",\n \"ip\",\n \"memswap\",\n \"processlist\",\n ...\n ]\n\n @apiError Cannot get plugin list.\n\n @apiErrorExample Error-Response:\n HTTP/1.1 404 Not Found",
"operationId": "_api_plugins_api_4_pluginslist_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/serverslist": {
"get": {
"summary": " Api Servers List",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the servers list (for browser mode)\nHTTP/200 if OK",
"operationId": "_api_servers_list_api_4_serverslist_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/processes/extended": {
"get": {
"summary": " Api Get Extended Processes",
"description": "Glances API RESTful implementation.\n\nGet the extended process stats (if set before)\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error",
"operationId": "_api_get_extended_processes_api_4_processes_extended_get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
}
}
}
},
"/api/4/processes/{pid}": {
"get": {
"summary": " Api Get Processes",
"description": "Glances API RESTful implementation.\n\nGet the process stats for the given PID\nHTTP/200 if OK\nHTTP/400 if PID is not found\nHTTP/404 if others error",
"operationId": "_api_get_processes_api_4_processes__pid__get",
"parameters": [
{
"name": "pid",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Pid" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}": {
"get": {
"summary": " Api",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_api_4__plugin__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/history": {
"get": {
"summary": " Api History",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin history\nLimit to the last nb items (all if nb=0)\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_history_api_4__plugin__history_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "nb",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Nb" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/history/{nb}": {
"get": {
"summary": " Api History",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin history\nLimit to the last nb items (all if nb=0)\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_history_api_4__plugin__history__nb__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "nb",
"in": "path",
"required": true,
"schema": { "type": "integer", "title": "Nb" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/top/{nb}": {
"get": {
"summary": " Api Top",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of a given plugin limited to the top nb items.\nIt is used to reduce the payload of the HTTP response (example: processlist).\n\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_top_api_4__plugin__top__nb__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "nb",
"in": "path",
"required": true,
"schema": { "type": "integer", "title": "Nb" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/limits": {
"get": {
"summary": " Api Limits",
"description": "Glances API RESTful implementation.\n\nReturn the JSON limits of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_limits_api_4__plugin__limits_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/views": {
"get": {
"summary": " Api Views",
"description": "Glances API RESTful implementation.\n\nReturn the JSON views of a given plugin\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_views_api_4__plugin__views_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}": {
"get": {
"summary": " Api Item",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_item_api_4__plugin___item__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/views": {
"get": {
"summary": " Api Item Views",
"description": "Glances API RESTful implementation.\n\nReturn the JSON view representation of the couple plugin/item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_item_views_api_4__plugin___item__views_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/history": {
"get": {
"summary": " Api Item History",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/history of item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_item_history_api_4__plugin___item__history_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
},
{
"name": "nb",
"in": "query",
"required": false,
"schema": { "type": "integer", "default": 0, "title": "Nb" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/history/{nb}": {
"get": {
"summary": " Api Item History",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/history of item\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_item_history_api_4__plugin___item__history__nb__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
},
{
"name": "nb",
"in": "path",
"required": true,
"schema": { "type": "integer", "title": "Nb" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/description": {
"get": {
"summary": " Api Item Description",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item description\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_item_description_api_4__plugin___item__description_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/unit": {
"get": {
"summary": " Api Item Unit",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of the couple plugin/item unit\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_item_unit_api_4__plugin___item__unit_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/value/{value}": {
"get": {
"summary": " Api Value",
"description": "Glances API RESTful implementation.\n\nReturn the process stats (dict) for the given item=value\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_value_api_4__plugin___item__value__value__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
},
{
"name": "value",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{ "type": "string" },
{ "type": "integer" },
{ "type": "number" }
],
"title": "Value"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/{key}": {
"get": {
"summary": " Api Key",
"description": "Glances API RESTful implementation.\n\nReturn the JSON representation of plugin/item/key\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_key_api_4__plugin___item___key__get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
},
{
"name": "key",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Key" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/api/4/{plugin}/{item}/{key}/views": {
"get": {
"summary": " Api Key Views",
"description": "Glances API RESTful implementation.\n\nReturn the JSON view representation of plugin/item/key\nHTTP/200 if OK\nHTTP/400 if plugin is not found\nHTTP/404 if others error",
"operationId": "_api_key_views_api_4__plugin___item___key__views_get",
"parameters": [
{
"name": "plugin",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Plugin" }
},
{
"name": "item",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Item" }
},
{
"name": "key",
"in": "path",
"required": true,
"schema": { "type": "string", "title": "Key" }
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": { "application/json": { "schema": {} } }
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
}
}
}
}
}
},
"/": {
"get": {
"summary": " Index",
"description": "Return main index.html (/) file.\n\nParameters are available through the request object.\nExample: http://localhost:61208/?refresh=5\n\nNote: This function is only called the first time the page is loaded.",
"operationId": "_index__get",
"responses": {
"200": {
"description": "Successful Response",
"content": { "text/html": { "schema": { "type": "string" } } }
}
}
}
}
},
"components": {
"schemas": {
"HTTPValidationError": {
"properties": {
"detail": {
"items": { "$ref": "#/components/schemas/ValidationError" },
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ValidationError": {
"properties": {
"loc": {
"items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] },
"type": "array",
"title": "Location"
},
"msg": { "type": "string", "title": "Message" },
"type": { "type": "string", "title": "Error Type" }
},
"type": "object",
"required": ["loc", "msg", "type"],
"title": "ValidationError"
}
}
}
}