diff options
Diffstat (limited to 'web/api/netdata-swagger.yaml')
| -rw-r--r-- | web/api/netdata-swagger.yaml | 61 |
1 files changed, 54 insertions, 7 deletions
diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml index 3386e01a7..50e661400 100644 --- a/web/api/netdata-swagger.yaml +++ b/web/api/netdata-swagger.yaml @@ -163,7 +163,7 @@ paths: type: array items: type: string - enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned', 'match-ids', 'match-names' ] + enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned', 'match-ids', 'match-names', 'showcustomvars' ] collectionFormat: pipes default: [seconds, jsonwrap] allowEmptyValue: false @@ -430,6 +430,38 @@ paths: type: array items: $ref: '#/definitions/alarm_log_entry' + /alarm_count: + get: + summary: 'Get an overall status of the chart' + description: "Checks multiple charts with the same context and counts number of alarms with given status." + parameters: + - in: query + name: context + description: "Specify context which should be checked" + required: false + allowEmptyValue: true + type: array + items: + type: string + collectionFormat: pipes + default: ['system.cpu'] + - in: query + name: status + description: "Specify alarm status to count" + required: false + allowEmptyValue: true + type: string + enum: ['REMOVED', 'UNDEFINED', 'UNINITIALIZED', 'CLEAR', 'RAISED', 'WARNING', 'CRITICAL'] + default: 'RAISED' + responses: + '200': + description: 'An object containing a count of alarms with given status for given contexts' + schema: + type: array + items: + type: number + '500': + description: 'Internal server error. This usually means the server is out of memory.' /manage/health: get: summary: 'Accesses the health management API to control health checks and notifications at runtime.' @@ -654,6 +686,11 @@ definitions: properties: key: $ref: '#/definitions/dimension' + chart_variables: + type: object + properties: + key: + $ref: '#/definitions/chart_variables' green: type: number description: 'Chart health green threshold' @@ -681,12 +718,8 @@ definitions: chart_variables: type: object properties: - varname1: - type: number - format: float - varname2: - type: number - format: float + key: + $ref: '#/definitions/chart_variables' family_variables: type: object properties: @@ -705,6 +738,15 @@ definitions: varname2: type: number format: float + chart_variables: + type: object + properties: + varname1: + type: number + format: float + varname2: + type: number + format: float dimension: type: object properties: @@ -776,6 +818,11 @@ definitions: format: type: string description: 'The format of the result returned.' + chart_variables: + type: object + properties: + key: + $ref: '#/definitions/chart_variables' result: description: 'The result requested, in the format requested.' alarms: |