Merge pull request #2021 from ktsaou/master

[netdata.git] / web / netdata-swagger.yaml

diff --git a/web/netdata-swagger.yaml b/web/netdata-swagger.yaml
index 8c96207908960336e74f4a48cb7e139b4fd2843a..a74d66f5dc03c042890ef5f94b594339f877c1b8 100644 (file)
--- a/web/netdata-swagger.yaml
+++ b/web/netdata-swagger.yaml
@@ -2,7 +2,7 @@ swagger: '2.0'
 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:
   - http
@@ -259,6 +259,23 @@ paths:
           description: 'No chart with the given id is found.'
         '500':
           description: 'Internal server error. This usually means the server is out of memory.'
+  /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:
   chart_summary:
     type: object
@@ -266,6 +283,16 @@ definitions:
       hostname:
         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.'
@@ -275,6 +302,18 @@ definitions:
         properties:
           key:
               $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.'
   chart:
     type: object
     properties:
@@ -327,13 +366,19 @@ definitions:
         properties:
           key:
               $ref: '#/definitions/dimension'
+      green:
+        type: number
+        description: 'Chart health green threshold'
+      red:
+        type: number
+        description: 'Chart health red trheshold'
   dimension:
     type: object
     properties:
       name:
         type: string
         description: 'The name of the dimension'
- 
+        
   json_wrap:
     type: object
     properties: