diff options
Diffstat (limited to 'web/api/netdata-swagger.json')
-rw-r--r-- | web/api/netdata-swagger.json | 96 |
1 files changed, 88 insertions, 8 deletions
diff --git a/web/api/netdata-swagger.json b/web/api/netdata-swagger.json index 63bc5638..1a0ec863 100644 --- a/web/api/netdata-swagger.json +++ b/web/api/netdata-swagger.json @@ -243,7 +243,8 @@ "percentage", "unaligned", "match-ids", - "match-names" + "match-names", + "showcustomvars" ], "collectionFormat": "pipes" }, @@ -656,6 +657,61 @@ } } }, + "/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.", @@ -975,6 +1031,14 @@ } } }, + "chart_variables": { + "type": "object", + "properties": { + "key": { + "$ref": "#/definitions/chart_variables" + } + } + }, "green": { "type": "number", "description": "Chart health green threshold" @@ -1011,13 +1075,8 @@ "chart_variables": { "type": "object", "properties": { - "varname1": { - "type": "number", - "format": "float" - }, - "varname2": { - "type": "number", - "format": "float" + "key": { + "$ref": "#/definitions/chart_variables" } } }, @@ -1049,6 +1108,19 @@ } } }, + "chart_variables": { + "type": "object", + "properties": { + "varname1": { + "type": "number", + "format": "float" + }, + "varname2": { + "type": "number", + "format": "float" + } + } + }, "dimension": { "type": "object", "properties": { @@ -1145,6 +1217,14 @@ "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." } |