summaryrefslogtreecommitdiffstats
path: root/web/api/netdata-swagger.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'web/api/netdata-swagger.yaml')
-rw-r--r--web/api/netdata-swagger.yaml70
1 files changed, 70 insertions, 0 deletions
diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml
index e5689e392..c021efefa 100644
--- a/web/api/netdata-swagger.yaml
+++ b/web/api/netdata-swagger.yaml
@@ -20,6 +20,8 @@ paths:
* netdata version
* netdata unique id
* list of hosts mirrored (includes itself)
+ * Operating System, Virtualization and Container technology information
+ * List of active collector plugins and modules
* number of alarms in the host
* number of alarms in normal state
* number of alarms in warning state
@@ -29,6 +31,8 @@ paths:
description: netdata basic information
schema:
$ref: '#/definitions/info'
+ '503':
+ description: netdata daemon not ready (used for health checks)
/charts:
get:
summary: 'Get a list of all charts available at the server'
@@ -460,6 +464,72 @@ definitions:
example:
- host1.example.com
- host2.example.com
+ os_name:
+ type: string
+ description: Operating System Name
+ example: Manjaro Linux
+ os_id:
+ type: string
+ description: Operating System ID
+ example: manjaro
+ os_id_like:
+ type: string
+ description: Known OS similar to this OS
+ example: arch
+ os_version:
+ type: string
+ description: Operating System Version
+ example: 18.0.4
+ os_version_id:
+ type: string
+ description: Operating System Version ID
+ example: unknown
+ os_detection:
+ type: string
+ description: OS parameters detection method
+ example: Mixed
+ kernel_name:
+ type: string
+ description: Kernel Name
+ example: Linux
+ kernel_version:
+ type: string
+ description: Kernel Version
+ example: 4.19.32-1-MANJARO
+ architecture:
+ type: string
+ description: Kernel architecture
+ example: x86_64
+ virtualization:
+ type: string
+ description: Virtualization Type
+ example: kvm
+ virt_detection:
+ type: string
+ description: Virtualization detection method
+ example: systemd-detect-virt
+ container:
+ type: string
+ description: Container technology
+ example: docker
+ container_detection:
+ type: string
+ description: Container technology detection method
+ example: dockerenv
+ collectors:
+ type: array
+ items:
+ type: object
+ description: Array of collector plugins and modules
+ properties:
+ plugin:
+ type: string
+ description: Collector plugin
+ example: python.d.plugin
+ module:
+ type: string
+ description: Module of the collector plugin
+ example: dockerd
alarms:
type: object
description: number of alarms in the server.