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. methods supported "min", "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: [ 'min', '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: alarm
 161           in: query
 162           description: 'the name of an alarm linked to the chart'
 163           required: false
 164           type: string
 165           format: 'any text'
 166           allowEmptyValue: true
 167         - name: dimension
 168           in: query
 169           description: 'zero, one or more dimension ids, as returned by the /chart call.'
 170           required: false
 171           type: array
 172           items:
 173             type: string
 174             collectionFormat: pipes
 175             format: 'as returned by /charts'
 176           allowEmptyValue: false
 177         - name: after
 178           in: query
 179           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.'
 180           required: true
 181           type: number
 182           format: integer
 183           allowEmptyValue: false
 184           default: -600
 185         - name: before
 186           in: query
 187           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.'
 188           required: false
 189           type: number
 190           format: integer
 191           default: 0
 192         - name: group
 193           in: query
 194           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. methods are supported "min", "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).'
 195           required: true
 196           type: string
 197           enum: [ 'min', 'max', 'average', 'sum', 'incremental-sum' ]
 198           default: 'average'
 199           allowEmptyValue: false
 200         - name: options
 201           in: query
 202           description: 'Options that affect data generation.'
 203           required: false
 204           type: array
 205           items:
 206             type: string
 207             enum: [ 'abs', 'absolute', 'absolute-sum', 'null2zero', 'percentage', 'unaligned' ]
 208             collectionFormat: pipes
 209           default: ['absolute']
 210           allowEmptyValue: true
 211         - name: label
 212           in: query
 213           description: 'a text to be used as the label'
 214           required: false
 215           type: string
 216           format: 'any text'
 217           allowEmptyValue: true
 218         - name: units
 219           in: query
 220           description: 'a text to be used as the units'
 221           required: false
 222           type: string
 223           format: 'any text'
 224           allowEmptyValue: true
 225         - name: label_color
 226           in: query
 227           description: 'a color to be used for the background of the label'
 228           required: false
 229           type: string
 230           format: 'any text'
 231           allowEmptyValue: true
 232         - name: value_color
 233           in: query
 234           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).'
 235           required: false
 236           type: string
 237           format: 'any text'
 238           allowEmptyValue: true
 239         - name: multiply
 240           in: query
 241           description: 'multiply 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         - name: divide
 247           in: query
 248           description: 'divide the value with this number for rendering it at the image (integer value required)'
 249           required: false
 250           type: number
 251           format: integer
 252           allowEmptyValue: true
 253       responses:
 254         '200':
 255           description: 'The call was successful. The response should be an SVG image.'
 256         '400':
 257           description: 'Bad request - the body will include a message stating what is wrong.'
 258         '404':
 259           description: 'No chart with the given id is found.'
 260         '500':
 261           description: 'Internal server error. This usually means the server is out of memory.'
 262 definitions:
 263   chart_summary:
 264     type: object
 265     properties:
 266       hostname:
 267         type: string
 268         description: 'The hostname of the netdata server.'
 269       update_every:
 270         type: number
 271         description: 'The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this.'
 272       charts:
 273         type: object
 274         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.'
 275         properties:
 276           key:
 277               $ref: '#/definitions/chart'
 278   chart:
 279     type: object
 280     properties:
 281       id:
 282         type: string
 283         description: 'The unique id of the chart'
 284       name:
 285         type: string
 286         description: 'The name of the chart'
 287       type:
 288         type: string
 289         description: 'The type of the chart. Types are not handled by netdata. You can use this field for anything you like.'
 290       family:
 291         type: string
 292         description: 'The family of the chart. Families are not handled by netdata. You can use this field for anything you like.'
 293       title:
 294         type: string
 295         description: 'The title of the chart.'
 296       priority:
 297         type: string
 298         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.'
 299       enabled:
 300         type: boolean
 301         description: 'True when the chart is enabled. Disabled charts do not currently collect values, but they may have historical values available.'
 302       units:
 303         type: string
 304         description: 'The unit of measurement for the values of all dimensions of the chart.'
 305       data_url:
 306         type: string
 307         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.'
 308       chart_type:
 309         type: string
 310         description: 'The chart type.'
 311         enum: [ 'line', 'area', 'stacked' ]
 312       duration:
 313         type: number
 314         description: 'The duration, in seconds, of the round robin database maintained by netdata.'
 315       first_entry:
 316         type: number
 317         description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database.'
 318       last_entry:
 319         type: number
 320         description: 'The UNIX timestamp of the latest entry in the round robin database.'
 321       update_every:
 322         type: number
 323         description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database.'
 324       dimensions:
 325         type: object
 326         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.'
 327         properties:
 328           key:
 329               $ref: '#/definitions/dimension'
 330   dimension:
 331     type: object
 332     properties:
 333       name:
 334         type: string
 335         description: 'The name of the dimension'
 336
 337   json_wrap:
 338     type: object
 339     properties:
 340       api:
 341         type: number
 342         description: 'The API version this conforms to, currently 1'
 343       id:
 344         type: string
 345         description: 'The unique id of the chart'
 346       name:
 347         type: string
 348         description: 'The name of the chart'
 349       update_every:
 350         type: number
 351         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).'
 352       view_update_every:
 353         type: number
 354         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.'
 355       first_entry:
 356         type: number
 357         description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database (indepedently of the current view).'
 358       last_entry:
 359         type: number
 360         description: 'The UNIX timestamp of the latest entry in the round robin database (indepedently of the current view).'
 361       after:
 362         type: number
 363         description: 'The UNIX timestamp of the first entry (the oldest) returned in this response.'
 364       before:
 365         type: number
 366         description: 'The UNIX timestamp of the latest entry returned in this response.'
 367       min:
 368         type: number
 369         description: 'The minimum value returned in the current view. This can be used to size the y-series of the chart.'
 370       max:
 371         type: number
 372         description: 'The maximum value returned in the current view. This can be used to size the y-series of the chart.'
 373       dimension_names:
 374         description: 'The dimension names of the chart as returned in the current view.'
 375         type: array
 376         items:
 377           type: string
 378       dimension_ids:
 379         description: 'The dimension IDs of the chart as returned in the current view.'
 380         type: array
 381         items:
 382           type: string
 383       latest_values:
 384         description: 'The latest values collected for the chart (indepedently of the current view).'
 385         type: array
 386         items:
 387           type: string
 388       view_latest_values:
 389         description: 'The latest values returned with this response.'
 390         type: array
 391         items:
 392           type: string
 393       dimensions:
 394         type: number
 395         description: 'The number of dimensions returned.'
 396       points:
 397         type: number
 398         description: 'The number of rows / points returned.'
 399       format:
 400         type: string
 401         description: 'The format of the result returned.'
 402       result:
 403         description: 'The result requested, in the format requested.'