summaryrefslogtreecommitdiffstats
path: root/web/netdata-swagger.yaml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--web/netdata-swagger.yaml70
1 files changed, 66 insertions, 4 deletions
diff --git a/web/netdata-swagger.yaml b/web/netdata-swagger.yaml
index ee9d243b0..a8abe1abf 100644
--- 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.5.1_rolling
+ version: 1.9.11_rolling
host: registry.my-netdata.io
schemes:
- http
@@ -56,7 +56,7 @@ paths:
default: system.cpu
- name: dimension
in: query
- description: 'zero, one or more dimension ids, as returned by the /chart call.'
+ description: 'zero, one or more dimension ids or names, as returned by the /chart call, separated with comma or pipe. Netdata simple patterns are supported.'
required: false
type: array
items:
@@ -95,6 +95,14 @@ paths:
enum: [ 'min', 'max', 'average', 'sum', 'incremental-sum' ]
default: 'average'
allowEmptyValue: false
+ - name: gtime
+ in: query
+ description: 'The grouping number of seconds. This is used in conjunction with group=average to change the units of metrics (ie when the data is per-second, setting gtime=60 will turn them to per-minute).'
+ required: false
+ type: number
+ format: integer
+ allowEmptyValue: false
+ default: 0
- name: format
in: query
description: 'The format of the data to be returned.'
@@ -110,7 +118,7 @@ paths:
type: array
items:
type: string
- enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned' ]
+ enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned', 'match-ids', 'match-names' ]
collectionFormat: pipes
default: [seconds, jsonwrap]
allowEmptyValue: false
@@ -250,6 +258,13 @@ paths:
type: number
format: integer
allowEmptyValue: true
+ - name: scale
+ in: query
+ description: 'set the scale of the badge (greater or equal to 100)'
+ required: false
+ type: number
+ format: integer
+ allowEmptyValue: true
responses:
'200':
description: 'The call was successful. The response should be an SVG image.'
@@ -269,8 +284,55 @@ paths:
description: 'The format of the response to be returned'
required: true
type: string
- enum: [ 'shell', 'prometheus' ]
+ enum: [ 'shell', 'prometheus', 'prometheus_all_hosts', 'json' ]
default: 'shell'
+ - name: help
+ in: query
+ description: 'enable or disable HELP lines in prometheus output'
+ required: false
+ type: string
+ enum: [ 'yes', 'no' ]
+ default: 'no'
+ - name: types
+ in: query
+ description: 'enable or disable TYPE lines in prometheus output'
+ required: false
+ type: string
+ enum: [ 'yes', 'no' ]
+ default: 'no'
+ - name: timestamps
+ in: query
+ description: 'enable or disable timestamps in prometheus output'
+ required: false
+ type: string
+ enum: [ 'yes', 'no' ]
+ default: 'yes'
+ - name: names
+ in: query
+ description: 'When enabled netdata will report dimension names. When disabled netdata will report dimension IDs. The default is controlled in netdata.conf.'
+ required: false
+ type: string
+ enum: [ 'yes', 'no' ]
+ default: 'yes'
+ - name: server
+ in: query
+ description: 'Set a distinct name of the client querying prometheus metrics. Netdata will use the client IP if this is not set.'
+ required: false
+ type: string
+ format: 'any text'
+ - name: prefix
+ in: query
+ description: 'Prefix all prometheus metrics with this string.'
+ required: false
+ type: string
+ format: 'any text'
+ - name: data
+ in: query
+ description: 'Select the prometheus response data source. The default is controlled in netdata.conf'
+ required: false
+ type: string
+ enum: [ 'as-collected', 'average', 'sum' ]
+ default: 'average'
responses:
'200':
description: 'All the metrics returned in the format requested'