summaryrefslogtreecommitdiffstats
path: root/web/api/netdata-swagger.yaml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-04-14 18:12:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-04-14 18:12:14 +0000
commitbb50acdcb8073654ea667b8c0272e335bd43f844 (patch)
tree1e00c8a29871426f8182658928dcb62e42d57ce8 /web/api/netdata-swagger.yaml
parentReleasing debian version 1.33.1-1. (diff)
downloadnetdata-bb50acdcb8073654ea667b8c0272e335bd43f844.tar.xz
netdata-bb50acdcb8073654ea667b8c0272e335bd43f844.zip
Merging upstream version 1.34.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'web/api/netdata-swagger.yaml')
-rw-r--r--web/api/netdata-swagger.yaml55
1 files changed, 43 insertions, 12 deletions
diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml
index 83487bda8..1e20ad0f5 100644
--- a/web/api/netdata-swagger.yaml
+++ b/web/api/netdata-swagger.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: Netdata API
description: Real-time performance and health monitoring.
- version: 1.11.1_rolling
+ version: 1.33.1
paths:
/info:
get:
@@ -14,6 +14,7 @@ paths:
* list of hosts mirrored (includes itself)
* Operating System, Virtualization, K8s nodes and Container technology information
* List of active collector plugins and modules
+ * Streaming information
* number of alarms in the host
* number of alarms in normal state
* number of alarms in warning state
@@ -169,6 +170,24 @@ paths:
type: number
format: integer
default: 20
+ - 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
@@ -201,6 +220,16 @@ paths:
type: number
format: integer
default: 0
+ - 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.
@@ -984,6 +1013,10 @@ components:
type: string
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.
@@ -1628,20 +1661,18 @@ components:
type: string
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
- 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.
+ aclk-version:
+ type: integer
+ description: Describes which ACLK version is currently used.
+ 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.
+ If false (user didn't perform claiming) agent will never attempt any cloud connection.
claimed_id:
type: string
format: uuid