web/netdata-swagger.yaml

   1 swagger: '2.0'
   2 info:
   3   title: NetData API
   4   description: 'Real time data collection and graphs...'
   5   version: 1.2.1_master
   6 host: netdata.firehol.org
   7 schemes:
   8   - http
   9 basePath: /api/v1
  10 produces:
  11   - application/json
  12 paths:
  13   /charts:
  14     get:
  15       summary: 'Get a list of all charts available at the server'
  16       description: 'The charts endpoint returns a summary about all charts stored in the netdata server.'
  17       responses:
  18         '200':
  19           description: 'An array of charts'
  20           schema:
  21             type: array
  22             items:
  23               $ref: '#/definitions/chart_summary'
  24   /chart:
  25     get:
  26       summary: 'Get info about a specific chart'
  27       description: 'The Chart endpoint returns detailed information about a chart.'
  28       parameters:
  29         - name: chart
  30           in: query
  31           description: 'The id of the chart as returned by the /charts call.'
  32           required: true
  33           type: string
  34           format: 'as returned by /charts'
  35           default: 'system.cpu'
  36       responses:
  37         '200':
  38           description: 'A javascript object with detailed information about the chart.'
  39           schema:
  40             $ref: '#/definitions/chart'
  41         '404':
  42           description: 'No chart with the given id is found.'
  43   /data:
  44     get:
  45       summary: 'Get collected data for a specific chart'
  46       description: |
  47         The Data endpoint returns data stored in the round robin database of a chart.
  48       parameters:
  49         - name: chart
  50           in: query
  51           description: 'The id of the chart as returned by the /charts call.'
  52           required: true
  53           type: string
  54           format: 'as returned by /charts'
  55           allowEmptyValue: false
  56           default: system.cpu
  57         - name: dimension
  58           in: query
  59           description: 'zero, one or more dimension ids, as returned by the /chart call.'
  60           required: false
  61           type: array
  62           items:
  63             type: string
  64             collectionFormat: pipes
  65             format: 'as returned by /charts'
  66           allowEmptyValue: false
  67         - name: after
  68           in: query
  69           description: 'This parameter can either be an absolute timestamp specifying the starting point of the data to be returned, or a relative number of seconds (relative to parameter: before). Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.'
  70           required: true
  71           type: number
  72           format: integer
  73           allowEmptyValue: false
  74           default: -600
  75         - name: before
  76           in: query
  77           description: 'This parameter can either be an absolute timestamp specifying the ending point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.'
  78           required: false
  79           type: number
  80           format: integer
  81           default: 0
  82         - name: points
  83           in: query
  84           description: 'The number of points to be returned. If not given, or it is <= 0, or it is bigger than the points stored in the round robin database for this chart for the given duration, all the available collected values for the given duration are returned.'
  85           required: true
  86           type: number
  87           format: integer
  88           allowEmptyValue: false
  89           default: 20
  90         - name: group
  91           in: query
  92           description: 'The grouping method. If multiple collected values are to be grouped in order to return fewer points, this parameters defines the method of grouping. 4 methods are supported, "max", "average", "sum", "incremental-sum". "max" is actually calculated on the absolute value collected (so it works for both positive and negative dimesions to return the most extreme value in either direction).'
  93           required: true
  94           type: string
  95           enum: [ 'max', 'average', 'sum', 'incremental-sum' ]
  96           default: 'average'
  97           allowEmptyValue: false
  98         - name: format
  99           in: query
 100           description: 'The format of the data to be returned.'
 101           required: true
 102           type: string
 103           enum: [ 'json', 'jsonp', 'csv', 'tsv', 'tsv-excel', 'ssv', 'ssvcomma', 'datatable', 'datasource', 'html', 'array', 'csvjsonarray' ]
 104           default: json
 105           allowEmptyValue: false
 106         - name: options
 107           in: query
 108           description: 'Options that affect data generation.'
 109           required: false
 110           type: array
 111           items:
 112             type: string
 113             enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned' ]
 114             collectionFormat: pipes
 115           default: [seconds, jsonwrap]
 116           allowEmptyValue: false
 117         - name: callback
 118           in: query
 119           description: 'For JSONP responses, the callback function name.'
 120           required: false
 121           type: string
 122           allowEmptyValue: true
 123         - name: filename
 124           in: query
 125           description: 'Add Content-Disposition: attachment; filename=<filename> header to the response, that will instruct the browser to save the response with the given filename.'
 126           required: false
 127           type: string
 128           allowEmptyValue: true
 129         - name: tqx
 130           in: query
 131           description: '[Google Visualization API](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source?hl=en) formatted parameter.'
 132           required: false
 133           type: string
 134           allowEmptyValue: true
 135       responses:
 136         '200':
 137           description: 'The call was successful. The response should include the data.'
 138           schema:
 139             $ref: '#/definitions/chart'
 140         '400':
 141           description: 'Bad request - the body will include a message stating what is wrong.'
 142         '404':
 143           description: 'No chart with the given id is found.'
 144         '500':
 145           description: 'Internal server error. This usually means the server is out of memory.'
 146   /badge.svg:
 147     get:
 148       summary: 'Generate a SVG image for a chart (or dimension)'
 149       description: |
 150         Successful responses are SVG images
 151       parameters:
 152         - name: chart
 153           in: query
 154           description: 'The id of the chart as returned by the /charts call.'
 155           required: true
 156           type: string
 157           format: 'as returned by /charts'
 158           allowEmptyValue: false
 159           default: system.cpu
 160         - name: dimension
 161           in: query
 162           description: 'zero, one or more dimension ids, as returned by the /chart call.'
 163           required: false
 164           type: array
 165           items:
 166             type: string
 167             collectionFormat: pipes
 168             format: 'as returned by /charts'
 169           allowEmptyValue: false
 170         - name: after
 171           in: query
 172           description: 'This parameter can either be an absolute timestamp specifying the starting point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.'
 173           required: true
 174           type: number
 175           format: integer
 176           allowEmptyValue: false
 177           default: -600
 178         - name: before
 179           in: query
 180           description: 'This parameter can either be an absolute timestamp specifying the ending point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.'
 181           required: false
 182           type: number
 183           format: integer
 184           default: 0
 185         - name: group
 186           in: query
 187           description: 'The grouping method. If multiple collected values are to be grouped in order to return fewer points, this parameters defines the method of grouping. 4 methods are supported, "max", "average", "sum", "incremental-sum". "max" is actually calculated on the absolute value collected (so it works for both positive and negative dimesions to return the most extreme value in either direction).'
 188           required: true
 189           type: string
 190           enum: [ 'max', 'average', 'sum', 'incremental-sum' ]
 191           default: 'average'
 192           allowEmptyValue: false
 193         - name: options
 194           in: query
 195           description: 'Options that affect data generation.'
 196           required: false
 197           type: array
 198           items:
 199             type: string
 200             enum: [ 'abs', 'absolute', 'absolute-sum', 'null2zero', 'percentage', 'unaligned' ]
 201             collectionFormat: pipes
 202           default: ['absolute']
 203           allowEmptyValue: true
 204         - name: label
 205           in: query
 206           description: 'a text to be used as the label'
 207           required: false
 208           type: string
 209           format: 'any text'
 210           allowEmptyValue: true
 211         - name: units
 212           in: query
 213           description: 'a text to be used as the units'
 214           required: false
 215           type: string
 216           format: 'any text'
 217           allowEmptyValue: true
 218         - name: label_color
 219           in: query
 220           description: 'a color to be used for the background of the label'
 221           required: false
 222           type: string
 223           format: 'any text'
 224           allowEmptyValue: true
 225         - name: value_color
 226           in: query
 227           description: 'a color to be used for the background of the label. You can set multiple using a pipe with a condition each, like this: color<value|color>value|color:null The following operators are supported: >, <, >=, <=, =, :null (to check if no value exists).'
 228           required: false
 229           type: string
 230           format: 'any text'
 231           allowEmptyValue: true
 232         - name: multiply
 233           in: query
 234           description: 'multiply the value with this number for rendering it at the image (integer value required)'
 235           required: false
 236           type: number
 237           format: integer
 238           allowEmptyValue: true
 239         - name: divide
 240           in: query
 241           description: 'divide the value with this number for rendering it at the image (integer value required)'
 242           required: false
 243           type: number
 244           format: integer
 245           allowEmptyValue: true
 246       responses:
 247         '200':
 248           description: 'The call was successful. The response should be an SVG image.'
 249         '400':
 250           description: 'Bad request - the body will include a message stating what is wrong.'
 251         '404':
 252           description: 'No chart with the given id is found.'
 253         '500':
 254           description: 'Internal server error. This usually means the server is out of memory.'
 255 definitions:
 256   chart_summary:
 257     type: object
 258     properties:
 259       hostname:
 260         type: string
 261         description: 'The hostname of the netdata server.'
 262       update_every:
 263         type: number
 264         description: 'The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this.'
 265       charts:
 266         type: object
 267         description: 'An object containing all the chart objects available at the netdata server. This is used as an indexed array. The key of each chart object is the id of the chart.'
 268         properties:
 269           key:
 270               $ref: '#/definitions/chart'
 271   chart:
 272     type: object
 273     properties:
 274       id:
 275         type: string
 276         description: 'The unique id of the chart'
 277       name:
 278         type: string
 279         description: 'The name of the chart'
 280       type:
 281         type: string
 282         description: 'The type of the chart. Types are not handled by netdata. You can use this field for anything you like.'
 283       family:
 284         type: string
 285         description: 'The family of the chart. Families are not handled by netdata. You can use this field for anything you like.'
 286       title:
 287         type: string
 288         description: 'The title of the chart.'
 289       priority:
 290         type: string
 291         description: 'The relative priority of the chart. NetData does not care about priorities. This is just an indication of importance for the chart viewers to sort charts of higher priority (lower number) closer to the top. Priority sorting should only be used among charts of the same type or family.'
 292       enabled:
 293         type: boolean
 294         description: 'True when the chart is enabled. Disabled charts do not currently collect values, but they may have historical values available.'
 295       units:
 296         type: string
 297         description: 'The unit of measurement for the values of all dimensions of the chart.'
 298       data_url:
 299         type: string
 300         description: 'The absolute path to get data values for this chart. You are expected to use this path as the base when constructing the URL to fetch data values for this chart.'
 301       chart_type:
 302         type: string
 303         description: 'The chart type.'
 304         enum: [ 'line', 'area', 'stacked' ]
 305       duration:
 306         type: number
 307         description: 'The duration, in seconds, of the round robin database maintained by netdata.'
 308       first_entry:
 309         type: number
 310         description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database.'
 311       last_entry:
 312         type: number
 313         description: 'The UNIX timestamp of the latest entry in the round robin database.'
 314       update_every:
 315         type: number
 316         description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database.'
 317       dimensions:
 318         type: object
 319         description: 'An object containing all the chart dimensions available for the chart. This is used as an indexed array. The key of the object the id of the dimension.'
 320         properties:
 321           key:
 322               $ref: '#/definitions/dimension'
 323   dimension:
 324     type: object
 325     properties:
 326       name:
 327         type: string
 328         description: 'The name of the dimension'
 329
 330   json_wrap:
 331     type: object
 332     properties:
 333       api:
 334         type: number
 335         description: 'The API version this conforms to, currently 1'
 336       id:
 337         type: string
 338         description: 'The unique id of the chart'
 339       name:
 340         type: string
 341         description: 'The name of the chart'
 342       update_every:
 343         type: number
 344         description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database (indepedently of the current view).'
 345       view_update_every:
 346         type: number
 347         description: 'The current view appropriate update frequency of this chart, in seconds. There is no point to request chart refreshes, using the same settings, more frequently than this.'
 348       first_entry:
 349         type: number
 350         description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database (indepedently of the current view).'
 351       last_entry:
 352         type: number
 353         description: 'The UNIX timestamp of the latest entry in the round robin database (indepedently of the current view).'
 354       after:
 355         type: number
 356         description: 'The UNIX timestamp of the first entry (the oldest) returned in this response.'
 357       before:
 358         type: number
 359         description: 'The UNIX timestamp of the latest entry returned in this response.'
 360       min:
 361         type: number
 362         description: 'The minimum value returned in the current view. This can be used to size the y-series of the chart.'
 363       max:
 364         type: number
 365         description: 'The maximum value returned in the current view. This can be used to size the y-series of the chart.'
 366       dimension_names:
 367         description: 'The dimension names of the chart as returned in the current view.'
 368         type: array
 369         items:
 370           type: string
 371       dimension_ids:
 372         description: 'The dimension IDs of the chart as returned in the current view.'
 373         type: array
 374         items:
 375           type: string
 376       latest_values:
 377         description: 'The latest values collected for the chart (indepedently of the current view).'
 378         type: array
 379         items:
 380           type: string
 381       view_latest_values:
 382         description: 'The latest values returned with this response.'
 383         type: array
 384         items:
 385           type: string
 386       dimensions:
 387         type: number
 388         description: 'The number of dimensions returned.'
 389       points:
 390         type: number
 391         description: 'The number of rows / points returned.'
 392       format:
 393         type: string
 394         description: 'The format of the result returned.'
 395       result:
 396         description: 'The result requested, in the format requested.'