diff options
Diffstat (limited to 'web/api/netdata-swagger.json')
| -rw-r--r-- | web/api/netdata-swagger.json | 66 |
1 files changed, 52 insertions, 14 deletions
diff --git a/web/api/netdata-swagger.json b/web/api/netdata-swagger.json index 7786b333a..4952e6116 100644 --- a/web/api/netdata-swagger.json +++ b/web/api/netdata-swagger.json @@ -3,13 +3,13 @@ "info": { "title": "Netdata API", "description": "Real-time performance and health monitoring.", - "version": "1.11.1_rolling" + "version": "1.33.1" }, "paths": { "/info": { "get": { "summary": "Get netdata basic information", - "description": "The info endpoint returns basic information about netdata. It provides:\n* netdata version\n* netdata unique id\n* list of hosts mirrored (includes itself)\n* Operating System, Virtualization, K8s nodes and Container technology information\n* List of active collector plugins and modules\n* number of alarms in the host\n * number of alarms in normal state\n * number of alarms in warning state\n * number of alarms in critical state\n", + "description": "The info endpoint returns basic information about netdata. It provides:\n* netdata version\n* netdata unique id\n* list of hosts mirrored (includes itself)\n* Operating System, Virtualization, K8s nodes and Container technology information\n* List of active collector plugins and modules\n* Streaming information\n* number of alarms in the host\n * number of alarms in normal state\n * number of alarms in warning state\n * number of alarms in critical state\n", "responses": { "200": { "description": "netdata basic information.", @@ -200,6 +200,28 @@ } }, { + "name": "chart_label_key", + "in": "query", + "description": "Specify the chart label keys that need to match for context queries as comma separated values. At least one matching key is needed to match the corresponding chart.", + "required": false, + "allowEmptyValue": false, + "schema": { + "type": "string", + "format": "key1,key2,key3" + } + }, + { + "name": "chart_labels_filter", + "in": "query", + "description": "Specify the chart label keys and values to match for context queries. All keys/values need to match for the chart to be included in the query. The labels are specified as key1:value1,key2:value2", + "required": false, + "allowEmptyValue": false, + "schema": { + "type": "string", + "format": "key1:value1,key2:value2,key3:value3" + } + }, + { "name": "group", "in": "query", "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 dimensions to return the most extreme value in either direction).", @@ -232,6 +254,18 @@ } }, { + "name": "timeout", + "in": "query", + "description": "Specify a timeout value in milliseconds after which the agent will abort the query and return a 503 error. A value of 0 indicates no timeout.", + "required": false, + "allowEmptyValue": false, + "schema": { + "type": "number", + "format": "integer", + "default": 0 + } + }, + { "name": "format", "in": "query", "description": "The format of the data to be returned.", @@ -1220,6 +1254,11 @@ "description": "Container technology detection method.", "example": "dockerenv" }, + "stream_compression": { + "type": "boolean", + "description": "Stream transmission compression method.", + "example": "true" + }, "labels": { "type": "object", "description": "List of host labels.", @@ -2085,21 +2124,20 @@ "type": "boolean", "description": "Describes whether this agent is capable of connection to the Cloud. False means agent has been built without ACLK component either on purpose (user choice) or due to missing dependency." }, - "aclk-implementation": { - "type": "string", - "description": "Describes which ACLK implementation is currently used.", - "enum": [ - "Next Generation", - "Legacy" - ] + "aclk-version": { + "type": "integer", + "description": "Describes which ACLK version is currently used." }, - "new-cloud-protocol-supported": { - "type": "boolean", - "description": "Informs about new protobuf based Cloud/Agent protocol support of this agent. If false agent has to be compiled with protobuf and protoc available." + "protocols-supported": { + "type": "array", + "description": "List of supported protocols for communication with Cloud.", + "items": { + "type": "string" + } }, "agent-claimed": { "type": "boolean", - "description": "Informs whether this agent has been added to a space in the cloud (User has to perform claiming). If false (user didnt perform claiming) agent will never attempt any cloud connection." + "description": "Informs whether this agent has been added to a space in the cloud (User has to perform claiming). If false (user didn't perform claiming) agent will never attempt any cloud connection." }, "claimed-id": { "type": "string", @@ -2122,4 +2160,4 @@ } } } -}
\ No newline at end of file +} |