diff options
Diffstat (limited to 'web/netdata-swagger.json')
| -rw-r--r-- | web/netdata-swagger.json | 71 |
1 files changed, 70 insertions, 1 deletions
diff --git a/web/netdata-swagger.json b/web/netdata-swagger.json index ad424abad..404944d12 100644 --- a/web/netdata-swagger.json +++ b/web/netdata-swagger.json @@ -3,7 +3,7 @@ "info": { "title": "NetData API", "description": "Real time data collection and graphs...", - "version": "1.4.1_master" + "version": "1.5.1_rolling" }, "host": "registry.my-netdata.io", "schemes": [ @@ -396,6 +396,34 @@ } } } + }, + "/allmetrics": { + "get": { + "summary": "Get a value of all the metrics maintained by netdata", + "description": "The charts endpoint returns the latest value of all charts and dimensions stored in the netdata server.", + "parameters": [ + { + "name": "format", + "in": "query", + "description": "The format of the response to be returned", + "required": true, + "type": "string", + "enum": [ + "shell", + "prometheus" + ], + "default": "shell" + } + ], + "responses": { + "200": { + "description": "All the metrics returned in the format requested" + }, + "400": { + "description": "The format requested is not supported" + } + } + } } }, "definitions": { @@ -406,6 +434,23 @@ "type": "string", "description": "The hostname of the netdata server." }, + "version": { + "type": "string", + "description": "netdata version of the server." + }, + "os": { + "type": "string", + "description": "The netdata server host operating system.", + "enum": [ + "macos", + "linux", + "freebsd" + ] + }, + "history": { + "type": "number", + "description": "The duration, in seconds, of the round robin database maintained by netdata." + }, "update_every": { "type": "number", "description": "The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this." @@ -418,6 +463,22 @@ "$ref": "#/definitions/chart" } } + }, + "charts_count": { + "type": "number", + "description": "The number of charts." + }, + "dimensions_count": { + "type": "number", + "description": "The total number of dimensions." + }, + "alarms_count": { + "type": "number", + "description": "The number of alarms." + }, + "rrd_memory_bytes": { + "type": "number", + "description": "The size of the round robin database in bytes." } } }, @@ -493,6 +554,14 @@ "$ref": "#/definitions/dimension" } } + }, + "green": { + "type": "number", + "description": "Chart health green threshold" + }, + "red": { + "type": "number", + "description": "Chart health red trheshold" } } }, |