Documenting the structure of the data responses. (#7012)
Documenting the structure of the /web/api/data responses (Fixes #7005) Swagger2.0 semi-supports this - they understand the sub-typing but do not show the sub-types in the model of the response directly. There are comments in each of the cases to guide the user towards the correct part of the model. For each kind of format request we have a data model of the response. Miscellaneous style improvements and typo fixes.
Andrew Moss committed
Oct 17, 2019 at 10:04 UTC
055eb9d214114c3e9eef00e02dfbacd067001de1
2 files changed
+942
-380
web/api/netdata-swagger.json
+240
-76
@@ -21,13 +21,13 @@
21
"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 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",
22
"responses": {
23
"200": {
24
- "description": "netdata basic information",
24
+ "description": "netdata basic information.",
25
"schema": {
26
"$ref": "#/definitions/info"
27
}
28
},
29
"503": {
30
- "description": "netdata daemon not ready (used for health checks)"
30
+ "description": "netdata daemon not ready (used for health checks)."
31
}
32
}
33
}
@@ -38,7 +38,7 @@
38
"description": "The charts endpoint returns a summary about all charts stored in the netdata server.",
39
"responses": {
40
"200": {
41
- "description": "An array of charts",
41
+ "description": "An array of charts.",
42
"schema": {
43
"type": "array",
44
"items": {
@@ -71,6 +71,9 @@
71
"$ref": "#/definitions/chart"
72
}
73
},
74
+ "400": {
75
+ "description": "No chart id was supplied in the request."
76
+ },
77
"404": {
78
"description": "No chart with the given id is found."
79
}
@@ -80,7 +83,7 @@
83
"/alarm_variables": {
84
"get": {
85
"summary": "List variables available to configure alarms for a chart",
83
- "description": "Returns the basic information of a chart and all the variables that can be used in alarm and template health configurations for the particular chart or family",
86
+ "description": "Returns the basic information of a chart and all the variables that can be used in alarm and template health configurations for the particular chart or family.",
87
"parameters": [
88
{
89
"name": "chart",
@@ -93,7 +96,7 @@
96
],
97
"responses": {
98
"200": {
96
- "description": "A javascript object with information about the chart and the available variables",
99
+ "description": "A javascript object with information about the chart and the available variables.",
100
"schema": {
101
"$ref": "#/definitions/alarm_variables"
102
}
@@ -113,7 +116,7 @@
116
"/data": {
117
"get": {
118
"summary": "Get collected data for a specific chart",
116
- "description": "The Data endpoint returns data stored in the round robin database of a chart.\n",
119
+ "description": "The data endpoint returns data stored in the round robin database of a chart.",
120
"parameters": [
121
{
122
"name": "chart",
@@ -128,7 +131,7 @@
131
{
132
"name": "dimension",
133
"in": "query",
131
- "description": "zero, one or more dimension ids or names, as returned by the /chart call, separated with comma or pipe. Netdata simple patterns are supported.",
134
+ "description": "Zero, one or more dimension ids or names, as returned by the /chart call, separated with comma or pipe. Netdata simple patterns are supported.",
135
"required": false,
136
"type": "array",
137
"items": {
@@ -281,9 +284,9 @@
284
],
285
"responses": {
286
"200": {
284
- "description": "The call was successful. The response should include the data.",
287
+ "description": "The call was successful. The response includes the data in the format requested. Swagger2.0 does not process the discriminator field to show polymorphism. The response will be one of the sub-types of the data-schema according to the chosen format, e.g. json -> data_json.",
288
"schema": {
286
- "$ref": "#/definitions/chart"
289
+ "$ref": "#/definitions/data"
290
}
291
},
292
"400": {
@@ -301,7 +304,7 @@
304
"/badge.svg": {
305
"get": {
306
"summary": "Generate a SVG image for a chart (or dimension)",
304
- "description": "Successful responses are SVG images\n",
307
+ "description": "Successful responses are SVG images.",
308
"parameters": [
309
{
310
"name": "chart",
@@ -316,7 +319,7 @@
319
{
320
"name": "alarm",
321
"in": "query",
319
- "description": "the name of an alarm linked to the chart",
322
+ "description": "The name of an alarm linked to the chart.",
323
"required": false,
324
"type": "string",
325
"format": "any text",
@@ -325,7 +328,7 @@
328
{
329
"name": "dimension",
330
"in": "query",
328
- "description": "zero, one or more dimension ids, as returned by the /chart call.",
331
+ "description": "Zero, one or more dimension ids, as returned by the /chart call.",
332
"required": false,
333
"type": "array",
334
"items": {
@@ -399,7 +402,7 @@
402
{
403
"name": "label",
404
"in": "query",
402
- "description": "a text to be used as the label",
405
+ "description": "A text to be used as the label.",
406
"required": false,
407
"type": "string",
408
"format": "any text",
@@ -408,7 +411,7 @@
411
{
412
"name": "units",
413
"in": "query",
411
- "description": "a text to be used as the units",
414
+ "description": "A text to be used as the units.",
415
"required": false,
416
"type": "string",
417
"format": "any text",
@@ -417,7 +420,7 @@
420
{
421
"name": "label_color",
422
"in": "query",
420
- "description": "a color to be used for the background of the label",
423
+ "description": "A color to be used for the background of the label.",
424
"required": false,
425
"type": "string",
426
"format": "any text",
@@ -426,7 +429,7 @@
429
{
430
"name": "value_color",
431
"in": "query",
429
- "description": "a color to be used for the background of the label. You can set multiple using a pipe with a condition each, like this: color<value|color>value|color:null The following operators are supported: >, <, >=, <=, =, :null (to check if no value exists).",
432
+ "description": "A color to be used for the background of the label. You can set multiple using a pipe with a condition each, like this: color<value|color>value|color:null The following operators are supported: >, <, >=, <=, =, :null (to check if no value exists).",
433
"required": false,
434
"type": "string",
435
"format": "any text",
@@ -435,7 +438,7 @@
438
{
439
"name": "multiply",
440
"in": "query",
438
- "description": "multiply the value with this number for rendering it at the image (integer value required)",
441
+ "description": "Multiply the value with this number for rendering it at the image (integer value required).",
442
"required": false,
443
"type": "number",
444
"format": "integer",
@@ -444,7 +447,7 @@
447
{
448
"name": "divide",
449
"in": "query",
447
- "description": "divide the value with this number for rendering it at the image (integer value required)",
450
+ "description": "Divide the value with this number for rendering it at the image (integer value required).",
451
"required": false,
452
"type": "number",
453
"format": "integer",
@@ -453,7 +456,7 @@
456
{
457
"name": "scale",
458
"in": "query",
456
- "description": "set the scale of the badge (greater or equal to 100)",
459
+ "description": "Set the scale of the badge (greater or equal to 100).",
460
"required": false,
461
"type": "number",
462
"format": "integer",
@@ -479,12 +482,12 @@
482
"/allmetrics": {
483
"get": {
484
"summary": "Get a value of all the metrics maintained by netdata",
482
- "description": "The charts endpoint returns the latest value of all charts and dimensions stored in the netdata server.",
485
+ "description": "The allmetrics endpoint returns the latest value of all charts and dimensions stored in the netdata server.",
486
"parameters": [
487
{
488
"name": "format",
489
"in": "query",
487
- "description": "The format of the response to be returned",
490
+ "description": "The format of the response to be returned.",
491
"required": true,
492
"type": "string",
493
"enum": [
@@ -498,7 +501,7 @@
501
{
502
"name": "help",
503
"in": "query",
501
- "description": "enable or disable HELP lines in prometheus output",
504
+ "description": "Enable or disable HELP lines in prometheus output.",
505
"required": false,
506
"type": "string",
507
"enum": [
@@ -510,7 +513,7 @@
513
{
514
"name": "types",
515
"in": "query",
513
- "description": "enable or disable TYPE lines in prometheus output",
516
+ "description": "Enable or disable TYPE lines in prometheus output.",
517
"required": false,
518
"type": "string",
519
"enum": [
@@ -522,7 +525,7 @@
525
{
526
"name": "timestamps",
527
"in": "query",
525
- "description": "enable or disable timestamps in prometheus output",
528
+ "description": "Enable or disable timestamps in prometheus output.",
529
"required": false,
530
"type": "string",
531
"enum": [
@@ -546,7 +549,7 @@
549
{
550
"name": "oldunits",
551
"in": "query",
549
- "description": "When enabled, netdata will show metric names for the default source=average as they appeared before 1.12, by using the legacy unit naming conventions",
552
+ "description": "When enabled, netdata will show metric names for the default source=average as they appeared before 1.12, by using the legacy unit naming conventions.",
553
"required": false,
554
"type": "string",
555
"enum": [
@@ -586,7 +589,7 @@
589
{
590
"name": "data",
591
"in": "query",
589
- "description": "Select the prometheus response data source. The default is controlled in netdata.conf",
592
+ "description": "Select the prometheus response data source. There is a setting in netdata.conf for the default.",
593
"required": false,
594
"type": "string",
595
"enum": [
@@ -599,10 +602,10 @@
602
],
603
"responses": {
604
"200": {
602
- "description": "All the metrics returned in the format requested"
605
+ "description": "All the metrics returned in the format requested."
606
},
607
"400": {
605
- "description": "The format requested is not supported"
608
+ "description": "The format requested is not supported."
609
}
610
}
611
}
@@ -615,7 +618,7 @@
618
{
619
"name": "all",
620
"in": "query",
618
- "description": "If passed, all enabled alarms are returned",
621
+ "description": "If passed, all enabled alarms are returned.",
622
"required": false,
623
"type": "boolean",
624
"allowEmptyValue": true
@@ -623,7 +626,7 @@
626
],
627
"responses": {
628
"200": {
626
- "description": "An object containing general info and a linked list of alarms",
629
+ "description": "An object containing general info and a linked list of alarms.",
630
"schema": {
631
"$ref": "#/definitions/alarms"
632
}
@@ -639,14 +642,14 @@
642
{
643
"name": "after",
644
"in": "query",
642
- "description": "Passing the parameter after=UNIQUEID returns all the events in the alarm log that occurred after UNIQUEID. An automated series of calls would call the interface once without after=, store the last UNIQUEID of the returned set, and give it back to get incrementally the next events",
645
+ "description": "Passing the parameter after=UNIQUEID returns all the events in the alarm log that occurred after UNIQUEID. An automated series of calls would call the interface once without after=, store the last UNIQUEID of the returned set, and give it back to get incrementally the next events.",
646
"required": false,
647
"type": "integer"
648
}
649
],
650
"responses": {
651
"200": {
649
- "description": "An array of alarm log entries",
652
+ "description": "An array of alarm log entries.",
653
"schema": {
654
"type": "array",
655
"items": {
@@ -665,7 +668,7 @@
668
{
669
"in": "query",
670
"name": "context",
668
- "description": "Specify context which should be checked",
671
+ "description": "Specify context which should be checked.",
672
"required": false,
673
"allowEmptyValue": true,
674
"type": "array",
@@ -680,7 +683,7 @@
683
{
684
"in": "query",
685
"name": "status",
683
- "description": "Specify alarm status to count",
686
+ "description": "Specify alarm status to count.",
687
"required": false,
688
"allowEmptyValue": true,
689
"type": "string",
@@ -698,7 +701,7 @@
701
],
702
"responses": {
703
"200": {
701
- "description": "An object containing a count of alarms with given status for given contexts",
704
+ "description": "An object containing a count of alarms with given status for given contexts.",
705
"schema": {
706
"type": "array",
707
"items": {
@@ -741,7 +744,7 @@
744
{
745
"name": "chart",
746
"in": "query",
744
- "description": "Chart ids/names, as shown on the dashboard. These will match the `on` entry of a configured `alarm`",
747
+ "description": "Chart ids/names, as shown on the dashboard. These will match the `on` entry of a configured `alarm`.",
748
"type": "string"
749
},
750
{
@@ -765,7 +768,7 @@
768
],
769
"responses": {
770
"200": {
768
- "description": "A plain text response based on the result of the command"
771
+ "description": "A plain text response based on the result of the command."
772
},
773
"403": {
774
"description": "Bearer authentication error."
@@ -790,7 +793,7 @@
793
},
794
"mirrored_hosts": {
795
"type": "array",
793
- "description": "list of hosts mirrored of the server (include itself).",
796
+ "description": "List of hosts mirrored of the server (include itself).",
797
"items": {
798
"type": "string"
799
},
@@ -801,83 +804,83 @@
804
},
805
"os_name": {
806
"type": "string",
804
- "description": "Operating System Name",
807
+ "description": "Operating System Name.",
808
"example": "Manjaro Linux"
809
},
810
"os_id": {
811
"type": "string",
809
- "description": "Operating System ID",
812
+ "description": "Operating System ID.",
813
"example": "manjaro"
814
},
815
"os_id_like": {
816
"type": "string",
814
- "description": "Known OS similar to this OS",
817
+ "description": "Known OS similar to this OS.",
818
"example": "arch"
819
},
820
"os_version": {
821
"type": "string",
819
- "description": "Operating System Version",
822
+ "description": "Operating System Version.",
823
"example": "18.0.4"
824
},
825
"os_version_id": {
826
"type": "string",
824
- "description": "Operating System Version ID",
827
+ "description": "Operating System Version ID.",
828
"example": "unknown"
829
},
830
"os_detection": {
831
"type": "string",
829
- "description": "OS parameters detection method",
832
+ "description": "OS parameters detection method.",
833
"example": "Mixed"
834
},
835
"kernel_name": {
836
"type": "string",
834
- "description": "Kernel Name",
837
+ "description": "Kernel Name.",
838
"example": "Linux"
839
},
840
"kernel_version": {
841
"type": "string",
839
- "description": "Kernel Version",
842
+ "description": "Kernel Version.",
843
"example": "4.19.32-1-MANJARO"
844
},
845
"architecture": {
846
"type": "string",
844
- "description": "Kernel architecture",
847
+ "description": "Kernel architecture.",
848
"example": "x86_64"
849
},
850
"virtualization": {
851
"type": "string",
849
- "description": "Virtualization Type",
852
+ "description": "Virtualization Type.",
853
"example": "kvm"
854
},
855
"virt_detection": {
856
"type": "string",
854
- "description": "Virtualization detection method",
857
+ "description": "Virtualization detection method.",
858
"example": "systemd-detect-virt"
859
},
860
"container": {
861
"type": "string",
859
- "description": "Container technology",
862
+ "description": "Container technology.",
863
"example": "docker"
864
},
865
"container_detection": {
866
"type": "string",
864
- "description": "Container technology detection method",
867
+ "description": "Container technology detection method.",
868
"example": "dockerenv"
869
},
870
"collectors": {
871
"type": "array",
872
"items": {
873
"type": "object",
871
- "description": "Array of collector plugins and modules",
874
+ "description": "Array of collector plugins and modules.",
875
"properties": {
876
"plugin": {
877
"type": "string",
875
- "description": "Collector plugin",
878
+ "description": "Collector plugin.",
879
"example": "python.d.plugin"
880
},
881
"module": {
882
"type": "string",
880
- "description": "Module of the collector plugin",
883
+ "description": "Module of the collector plugin.",
884
"example": "dockerd"
885
}
886
}
@@ -885,19 +888,19 @@
888
},
889
"alarms": {
890
"type": "object",
888
- "description": "number of alarms in the server.",
891
+ "description": "Number of alarms in the server.",
892
"properties": {
893
"normal": {
894
"type": "integer",
892
- "description": "number of alarms in normal state."
895
+ "description": "Number of alarms in normal state."
896
},
897
"warning": {
898
"type": "integer",
896
- "description": "number of alarms in warning state."
899
+ "description": "Number of alarms in warning state."
900
},
901
"critical": {
902
"type": "integer",
900
- "description": "number of alarms in critical state."
903
+ "description": "Number of alarms in critical state."
904
}
905
}
906
}
@@ -914,6 +917,15 @@
917
"type": "string",
918
"description": "netdata version of the server."
919
},
920
+ "release_channel": {
921
+ "type": "string",
922
+ "description": "The release channel of the build on the server.",
923
+ "example": "nightly"
924
+ },
925
+ "timezone": {
926
+ "type": "string",
927
+ "description": "The current timezone on the server."
928
+ },
929
"os": {
930
"type": "string",
931
"description": "The netdata server host operating system.",
@@ -927,6 +939,10 @@
939
"type": "number",
940
"description": "The duration, in seconds, of the round robin database maintained by netdata."
941
},
942
+ "memory_mode": {
943
+ "type": "string",
944
+ "description": "The name of the database memory mode on the server."
945
+ },
946
"update_every": {
947
"type": "number",
948
"description": "The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this."
@@ -963,11 +979,11 @@
979
"properties": {
980
"id": {
981
"type": "string",
966
- "description": "The unique id of the chart"
982
+ "description": "The unique id of the chart."
983
},
984
"name": {
985
"type": "string",
970
- "description": "The name of the chart"
986
+ "description": "The name of the chart."
987
},
988
"type": {
989
"type": "string",
@@ -1041,11 +1057,11 @@
1057
},
1058
"green": {
1059
"type": "number",
1044
- "description": "Chart health green threshold"
1060
+ "description": "Chart health green threshold."
1061
},
1062
"red": {
1063
"type": "number",
1048
- "description": "Chart health red trheshold"
1064
+ "description": "Chart health red threshold."
1065
}
1066
}
1067
},
@@ -1054,15 +1070,15 @@
1070
"properties": {
1071
"chart": {
1072
"type": "string",
1057
- "description": "The unique id of the chart"
1073
+ "description": "The unique id of the chart."
1074
},
1075
"chart_name": {
1076
"type": "string",
1061
- "description": "The name of the chart"
1077
+ "description": "The name of the chart."
1078
},
1079
"cnart_context": {
1080
"type": "string",
1065
- "description": "The context of the chart. It is shared across multiple monitored software or hardware instances and used in alarm templates"
1081
+ "description": "The context of the chart. It is shared across multiple monitored software or hardware instances and used in alarm templates."
1082
},
1083
"family": {
1084
"type": "string",
@@ -1126,24 +1142,26 @@
1142
"properties": {
1143
"name": {
1144
"type": "string",
1129
- "description": "The name of the dimension"
1145
+ "description": "The name of the dimension."
1146
}
1147
}
1148
},
1133
- "json_wrap": {
1149
+ "data": {
1150
"type": "object",
1151
+ "discriminator": "format",
1152
+ "description": "Response will contain the appropriate subtype, e.g. data_json depending on the requested format.",
1153
"properties": {
1154
"api": {
1155
"type": "number",
1138
- "description": "The API version this conforms to, currently 1"
1156
+ "description": "The API version this conforms to, currently 1."
1157
},
1158
"id": {
1159
"type": "string",
1142
- "description": "The unique id of the chart"
1160
+ "description": "The unique id of the chart."
1161
},
1162
"name": {
1163
"type": "string",
1146
- "description": "The name of the chart"
1164
+ "description": "The name of the chart."
1165
},
1166
"update_every": {
1167
"type": "number",
@@ -1224,12 +1242,158 @@
1242
"$ref": "#/definitions/chart_variables"
1243
}
1244
}
1227
- },
1228
- "result": {
1229
- "description": "The result requested, in the format requested."
1245
}
1246
}
1247
},
1248
+ "data_json": {
1249
+ "description": "Data response in json format.",
1250
+ "allOf": [
1251
+ {
1252
+ "$ref": "#/definitions/data"
1253
+ },
1254
+ {
1255
+ "properties": {
1256
+ "result": {
1257
+ "type": "object",
1258
+ "properties": {
1259
+ "labels": {
1260
+ "description": "The dimensions retrieved from the chart.",
1261
+ "type": "array",
1262
+ "items": {
1263
+ "type": "string"
1264
+ }
1265
+ },
1266
+ "data": {
1267
+ "description": "The data requested, one element per sample with each element containing the values of the dimensions described in the labels value.",
1268
+ "type": "array",
1269
+ "items": {
1270
+ "type": "number"
1271
+ }
1272
+ }
1273
+ },
1274
+ "description": "The result requested, in the format requested."
1275
+ }
1276
+ }
1277
+ }
1278
+ ]
1279
+ },
1280
+ "data_flat": {
1281
+ "description": "Data response in csv / tsv / tsv-excel / ssv / ssv-comma / markdown / html formats.",
1282
+ "allOf": [
1283
+ {
1284
+ "$ref": "#/definitions/data"
1285
+ },
1286
+ {
1287
+ "properties": {
1288
+ "result": {
1289
+ "type": "string"
1290
+ }
1291
+ }
1292
+ }
1293
+ ]
1294
+ },
1295
+ "data_array": {
1296
+ "description": "Data response in array format.",
1297
+ "allOf": [
1298
+ {
1299
+ "$ref": "#/definitions/data"
1300
+ },
1301
+ {
1302
+ "properties": {
1303
+ "result": {
1304
+ "type": "array",
1305
+ "items": {
1306
+ "type": "number"
1307
+ }
1308
+ }
1309
+ }
1310
+ }
1311
+ ]
1312
+ },
1313
+ "data_csvjsonarray": {
1314
+ "description": "Data response in csvjsonarray format.",
1315
+ "allOf": [
1316
+ {
1317
+ "$ref": "#/definitions/data"
1318
+ },
1319
+ {
1320
+ "properties": {
1321
+ "result": {
1322
+ "description": "The first inner array contains strings showing the labels of each column, each subsequent array contains the values for each point in time.",
1323
+ "type": "array",
1324
+ "items": {
1325
+ "type": "array",
1326
+ "items": {}
1327
+ }
1328
+ }
1329
+ }
1330
+ }
1331
+ ]
1332
+ },
1333
+ "data_datatable": {
1334
+ "description": "Data response in datatable / datasource formats (suitable for Google Charts).",
1335
+ "allOf": [
1336
+ {
1337
+ "$ref": "#/definitions/data"
1338
+ },
1339
+ {
1340
+ "properties": {
1341
+ "result": {
1342
+ "type": "object",
1343
+ "properties": {
1344
+ "cols": {
1345
+ "type": "array",
1346
+ "items": {
1347
+ "type": "object",
1348
+ "properties": {
1349
+ "id": {
1350
+ "description": "Always empty - for future use."
1351
+ },
1352
+ "label": {
1353
+ "description": "The dimension returned from the chart."
1354
+ },
1355
+ "pattern": {
1356
+ "description": "Always empty - for future use."
1357
+ },
1358
+ "type": {
1359
+ "description": "The type of data in the column / chart-dimension."
1360
+ },
1361
+ "p": {
1362
+ "description": "Contains any annotations for the column."
1363
+ }
1364
+ },
1365
+ "required": [
1366
+ "id",
1367
+ "label",
1368
+ "pattern",
1369
+ "type"
1370
+ ]
1371
+ }
1372
+ },
1373
+ "rows": {
1374
+ "type": "array",
1375
+ "items": {
1376
+ "type": "object",
1377
+ "properties": {
1378
+ "c": {
1379
+ "type": "array",
1380
+ "items": {
1381
+ "properties": {
1382
+ "v": {
1383
+ "description": "Each value in the row is represented by an object named `c` with five v fields: data, null, null, 0, the value. This format is fixed by the Google Charts API."
1384
+ }
1385
+ }
1386
+ }
1387
+ }
1388
+ }
1389
+ }
1390
+ }
1391
+ }
1392
+ }
1393
+ }
1394
+ }
1395
+ ]
1396
+ },
1397
"alarms": {
1398
"type": "object",
1399
"properties": {
@@ -1259,7 +1423,7 @@
1423
},
1424
"name": {
1425
"type": "string",
1262
- "description": "Full alarm name"
1426
+ "description": "Full alarm name."
1427
},
1428
"chart": {
1429
"type": "string"
@@ -1269,7 +1433,7 @@
1433
},
1434
"active": {
1435
"type": "boolean",
1272
- "description": "Will be false only if the alarm is disabled in the configuration"
1436
+ "description": "Will be false only if the alarm is disabled in the configuration."
1437
},
1438
"disabled": {
1439
"type": "boolean",
@@ -1524,4 +1688,4 @@
1688
}
1689
}
1690
}
1527
-}
\ No newline at end of file
1691
+}
web/api/netdata-swagger.yaml
+702
-304
@@ -1,8 +1,7 @@
1
-# SPDX-License-Identifier: GPL-3.0-or-later
1
swagger: '2.0'
2
info:
3
title: NetData API
5
- description: 'Real-time performance and health monitoring.'
4
+ description: Real-time performance and health monitoring.
5
version: 1.11.1_rolling
6
host: registry.my-netdata.io
7
schemes:
@@ -28,90 +27,113 @@ paths:
27
* number of alarms in critical state
28
responses:
29
'200':
31
- description: netdata basic information
30
+ description: netdata basic information.
31
schema:
32
$ref: '#/definitions/info'
33
'503':
35
- description: netdata daemon not ready (used for health checks)
34
+ description: netdata daemon not ready (used for health checks).
35
/charts:
36
get:
38
- summary: 'Get a list of all charts available at the server'
39
- description: 'The charts endpoint returns a summary about all charts stored in the netdata server.'
37
+ summary: Get a list of all charts available at the server
38
+ description: >-
39
+ The charts endpoint returns a summary about all charts stored in the
40
+ netdata server.
41
responses:
42
'200':
42
- description: 'An array of charts'
43
+ description: An array of charts.
44
schema:
45
type: array
46
items:
47
$ref: '#/definitions/chart_summary'
48
/chart:
49
get:
49
- summary: 'Get info about a specific chart'
50
- description: 'The Chart endpoint returns detailed information about a chart.'
50
+ summary: Get info about a specific chart
51
+ description: The Chart endpoint returns detailed information about a chart.
52
parameters:
53
- name: chart
54
in: query
54
- description: 'The id of the chart as returned by the /charts call.'
55
+ description: The id of the chart as returned by the /charts call.
56
required: true
57
type: string
57
- format: 'as returned by /charts'
58
- default: 'system.cpu'
58
+ format: as returned by /charts
59
+ default: system.cpu
60
responses:
61
'200':
61
- description: 'A javascript object with detailed information about the chart.'
62
+ description: A javascript object with detailed information about the chart.
63
schema:
64
$ref: '#/definitions/chart'
65
+ '400':
66
+ description: No chart id was supplied in the request.
67
'404':
65
- description: 'No chart with the given id is found.'
68
+ description: No chart with the given id is found.
69
/alarm_variables:
70
get:
68
- summary: 'List variables available to configure alarms for a chart'
69
- description: 'Returns the basic information of a chart and all the variables that can be used in alarm and template health configurations for the particular chart or family'
71
+ summary: List variables available to configure alarms for a chart
72
+ description: >-
73
+ Returns the basic information of a chart and all the variables that can
74
+ be used in alarm and template health configurations for the particular
75
+ chart or family.
76
parameters:
77
- name: chart
78
in: query
73
- description: 'The id of the chart as returned by the /charts call.'
79
+ description: The id of the chart as returned by the /charts call.
80
required: true
81
type: string
76
- format: 'as returned by /charts'
82
+ format: as returned by /charts
83
responses:
84
'200':
79
- description: 'A javascript object with information about the chart and the available variables'
80
- schema:
81
- $ref: '#/definitions/alarm_variables'
85
+ description: >-
86
+ A javascript object with information about the chart and the
87
+ available variables.
88
+ schema:
89
+ $ref: '#/definitions/alarm_variables'
90
'400':
83
- description: 'Bad request - the body will include a message stating what is wrong.'
91
+ description: Bad request - the body will include a message stating what is wrong.
92
'404':
85
- description: 'No chart with the given id is found.'
93
+ description: No chart with the given id is found.
94
'500':
87
- description: 'Internal server error. This usually means the server is out of memory.'
95
+ description: >-
96
+ Internal server error. This usually means the server is out of
97
+ memory.
98
/data:
99
get:
90
- summary: 'Get collected data for a specific chart'
91
- description: |
92
- The Data endpoint returns data stored in the round robin database of a chart.
100
+ summary: Get collected data for a specific chart
101
+ description: >-
102
+ The data endpoint returns data stored in the round robin database of a
103
+ chart.
104
parameters:
105
- name: chart
106
in: query
96
- description: 'The id of the chart as returned by the /charts call.'
107
+ description: The id of the chart as returned by the /charts call.
108
required: true
109
type: string
99
- format: 'as returned by /charts'
110
+ format: as returned by /charts
111
allowEmptyValue: false
112
default: system.cpu
113
- name: dimension
114
in: query
104
- description: 'zero, one or more dimension ids or names, as returned by the /chart call, separated with comma or pipe. Netdata simple patterns are supported.'
115
+ description: >-
116
+ Zero, one or more dimension ids or names, as returned by the /chart
117
+ call, separated with comma or pipe. Netdata simple patterns are
118
+ supported.
119
required: false
120
type: array
121
items:
122
type: string
123
collectionFormat: pipes
110
- format: 'as returned by /charts'
124
+ format: as returned by /charts
125
allowEmptyValue: false
126
- name: after
127
in: query
114
- description: 'This parameter can either be an absolute timestamp specifying the starting point of the data to be returned, or a relative number of seconds (negative, relative to parameter: before). Netdata will assume it is a relative number if it is less that 3 years (in seconds). Netdata will adapt this parameter to the boundaries of the round robin database. The default is the beginning of the round robin database (i.e. by default netdata will attempt to return data for the entire database).'
128
+ description: >-
129
+ This parameter can either be an absolute timestamp specifying the
130
+ starting point of the data to be returned, or a relative number of
131
+ seconds (negative, relative to parameter: before). Netdata will
132
+ assume it is a relative number if it is less that 3 years (in
133
+ seconds). Netdata will adapt this parameter to the boundaries of the
134
+ round robin database. The default is the beginning of the round
135
+ robin database (i.e. by default netdata will attempt to return data
136
+ for the entire database).
137
required: true
138
type: number
139
format: integer
@@ -119,14 +141,25 @@ paths:
141
default: -600
142
- name: before
143
in: query
122
- description: 'This parameter can either be an absolute timestamp specifying the ending point of the data to be returned, or a relative number of seconds (negative), relative to the last collected timestamp. Netdata will assume it is a relative number if it is less than 3 years (in seconds). Netdata will adapt this parameter to the boundaries of the round robin database. The default is zero (i.e. the timestamp of the last value collected).'
144
+ description: >-
145
+ This parameter can either be an absolute timestamp specifying the
146
+ ending point of the data to be returned, or a relative number of
147
+ seconds (negative), relative to the last collected timestamp.
148
+ Netdata will assume it is a relative number if it is less than 3
149
+ years (in seconds). Netdata will adapt this parameter to the
150
+ boundaries of the round robin database. The default is zero (i.e.
151
+ the timestamp of the last value collected).
152
required: false
153
type: number
154
format: integer
155
default: 0
156
- name: points
157
in: query
129
- description: 'The number of points to be returned. If not given, or it is <= 0, or it is bigger than the points stored in the round robin database for this chart for the given duration, all the available collected values for the given duration will be returned.'
158
+ description: >-
159
+ The number of points to be returned. If not given, or it is <= 0, or
160
+ it is bigger than the points stored in the round robin database for
161
+ this chart for the given duration, all the available collected
162
+ values for the given duration will be returned.
163
required: true
164
type: number
165
format: integer
@@ -134,15 +167,31 @@ paths:
167
default: 20
168
- name: group
169
in: query
137
- 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 dimesions to return the most extreme value in either direction).'
170
+ description: >-
171
+ The grouping method. If multiple collected values are to be grouped
172
+ in order to return fewer points, this parameters defines the method
173
+ of grouping. methods supported "min", "max", "average", "sum",
174
+ "incremental-sum". "max" is actually calculated on the absolute
175
+ value collected (so it works for both positive and negative
176
+ dimesions to return the most extreme value in either direction).
177
required: true
178
type: string
140
- enum: [ 'min', 'max', 'average', 'median', 'stddev', 'sum', 'incremental-sum' ]
141
- default: 'average'
179
+ enum:
180
+ - min
181
+ - max
182
+ - average
183
+ - median
184
+ - stddev
185
+ - sum
186
+ - incremental-sum
187
+ default: average
188
allowEmptyValue: false
189
- name: gtime
190
in: query
145
- description: 'The grouping number of seconds. This is used in conjunction with group=average to change the units of metrics (ie when the data is per-second, setting gtime=60 will turn them to per-minute).'
191
+ description: >-
192
+ The grouping number of seconds. This is used in conjunction with
193
+ group=average to change the units of metrics (ie when the data is
194
+ per-second, setting gtime=60 will turn them to per-minute).
195
required: false
196
type: number
197
format: integer
@@ -150,22 +199,54 @@ paths:
199
default: 0
200
- name: format
201
in: query
153
- description: 'The format of the data to be returned.'
202
+ description: The format of the data to be returned.
203
required: true
204
type: string
156
- enum: [ 'json', 'jsonp', 'csv', 'tsv', 'tsv-excel', 'ssv', 'ssvcomma', 'datatable', 'datasource', 'html', 'markdown', 'array', 'csvjsonarray' ]
205
+ enum:
206
+ - json
207
+ - jsonp
208
+ - csv
209
+ - tsv
210
+ - tsv-excel
211
+ - ssv
212
+ - ssvcomma
213
+ - datatable
214
+ - datasource
215
+ - html
216
+ - markdown
217
+ - array
218
+ - csvjsonarray
219
default: json
220
allowEmptyValue: false
221
- name: options
222
in: query
161
- description: 'Options that affect data generation.'
223
+ description: Options that affect data generation.
224
required: false
225
type: array
226
items:
227
type: string
166
- enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json', 'percentage', 'unaligned', 'match-ids', 'match-names', 'showcustomvars' ]
228
+ enum:
229
+ - nonzero
230
+ - flip
231
+ - jsonwrap
232
+ - min2max
233
+ - seconds
234
+ - milliseconds
235
+ - abs
236
+ - absolute
237
+ - absolute-sum
238
+ - null2zero
239
+ - objectrows
240
+ - google_json
241
+ - percentage
242
+ - unaligned
243
+ - match-ids
244
+ - match-names
245
+ - showcustomvars
246
collectionFormat: pipes
168
- default: [seconds, jsonwrap]
247
+ default:
248
+ - seconds
249
+ - jsonwrap
250
allowEmptyValue: false
251
- name: callback
252
in: query
@@ -175,61 +256,81 @@ paths:
256
allowEmptyValue: true
257
- name: filename
258
in: query
178
- description: 'Add Content-Disposition: attachment; filename=<filename> header to the response, that will instruct the browser to save the response with the given filename.'
259
+ description: >-
260
+ Add Content-Disposition: attachment; filename=<filename> header to
261
+ the response, that will instruct the browser to save the response
262
+ with the given filename.
263
required: false
264
type: string
265
allowEmptyValue: true
266
- name: tqx
267
in: query
184
- description: '[Google Visualization API](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source?hl=en) formatted parameter.'
268
+ description: >-
269
+ [Google Visualization
270
+ API](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source?hl=en)
271
+ formatted parameter.
272
required: false
273
type: string
274
allowEmptyValue: true
275
responses:
276
'200':
190
- description: 'The call was successful. The response should include the data.'
277
+ description: >-
278
+ The call was successful. The response includes the data in the
279
+ format requested. Swagger2.0 does not process the discriminator
280
+ field to show polymorphism. The response will be one of the
281
+ sub-types of the data-schema according to the chosen format, e.g.
282
+ json -> data_json.
283
schema:
192
- $ref: '#/definitions/chart'
284
+ $ref: '#/definitions/data'
285
'400':
194
- description: 'Bad request - the body will include a message stating what is wrong.'
286
+ description: Bad request - the body will include a message stating what is wrong.
287
'404':
196
- description: 'No chart with the given id is found.'
288
+ description: No chart with the given id is found.
289
'500':
198
- description: 'Internal server error. This usually means the server is out of memory.'
290
+ description: >-
291
+ Internal server error. This usually means the server is out of
292
+ memory.
293
/badge.svg:
294
get:
201
- summary: 'Generate a SVG image for a chart (or dimension)'
202
- description: |
203
- Successful responses are SVG images
295
+ summary: Generate a SVG image for a chart (or dimension)
296
+ description: Successful responses are SVG images.
297
parameters:
298
- name: chart
299
in: query
207
- description: 'The id of the chart as returned by the /charts call.'
300
+ description: The id of the chart as returned by the /charts call.
301
required: true
302
type: string
210
- format: 'as returned by /charts'
303
+ format: as returned by /charts
304
allowEmptyValue: false
305
default: system.cpu
306
- name: alarm
307
in: query
215
- description: 'the name of an alarm linked to the chart'
308
+ description: The name of an alarm linked to the chart.
309
required: false
310
type: string
218
- format: 'any text'
311
+ format: any text
312
allowEmptyValue: true
313
- name: dimension
314
in: query
222
- description: 'zero, one or more dimension ids, as returned by the /chart call.'
315
+ description: 'Zero, one or more dimension ids, as returned by the /chart call.'
316
required: false
317
type: array
318
items:
319
type: string
320
collectionFormat: pipes
228
- format: 'as returned by /charts'
321
+ format: as returned by /charts
322
allowEmptyValue: false
323
- name: after
324
in: query
232
- description: 'This parameter can either be an absolute timestamp specifying the starting point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.'
325
+ description: >-
326
+ This parameter can either be an absolute timestamp specifying the
327
+ starting point of the data to be returned, or a relative number of
328
+ seconds, to the last collected timestamp. Netdata will assume it is
329
+ a relative number if it is smaller than the duration of the round
330
+ robin database for this chart. So, if the round robin database is
331
+ 3600 seconds, any value from -3600 to 3600 will trigger relative
332
+ arithmetics. Netdata will adapt this parameter to the boundaries of
333
+ the round robin database.
334
required: true
335
type: number
336
format: integer
@@ -237,267 +338,391 @@ paths:
338
default: -600
339
- name: before
340
in: query
240
- description: 'This parameter can either be an absolute timestamp specifying the ending point of the data to be returned, or a relative number of seconds, to the last collected timestamp. Netdata will assume it is a relative number if it is smaller than the duration of the round robin database for this chart. So, if the round robin database is 3600 seconds, any value from -3600 to 3600 will trigger relative arithmetics. Netdata will adapt this parameter to the boundaries of the round robin database.'
341
+ description: >-
342
+ This parameter can either be an absolute timestamp specifying the
343
+ ending point of the data to be returned, or a relative number of
344
+ seconds, to the last collected timestamp. Netdata will assume it is
345
+ a relative number if it is smaller than the duration of the round
346
+ robin database for this chart. So, if the round robin database is
347
+ 3600 seconds, any value from -3600 to 3600 will trigger relative
348
+ arithmetics. Netdata will adapt this parameter to the boundaries of
349
+ the round robin database.
350
required: false
351
type: number
352
format: integer
353
default: 0
354
- name: group
355
in: query
247
- 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 are supported "min", "max", "average", "sum", "incremental-sum". "max" is actually calculated on the absolute value collected (so it works for both positive and negative dimesions to return the most extreme value in either direction).'
356
+ description: >-
357
+ The grouping method. If multiple collected values are to be grouped
358
+ in order to return fewer points, this parameters defines the method
359
+ of grouping. methods are supported "min", "max", "average", "sum",
360
+ "incremental-sum". "max" is actually calculated on the absolute
361
+ value collected (so it works for both positive and negative
362
+ dimesions to return the most extreme value in either direction).
363
required: true
364
type: string
250
- enum: [ 'min', 'max', 'average', 'median', 'stddev', 'sum', 'incremental-sum' ]
251
- default: 'average'
365
+ enum:
366
+ - min
367
+ - max
368
+ - average
369
+ - median
370
+ - stddev
371
+ - sum
372
+ - incremental-sum
373
+ default: average
374
allowEmptyValue: false
375
- name: options
376
in: query
255
- description: 'Options that affect data generation.'
377
+ description: Options that affect data generation.
378
required: false
379
type: array
380
items:
381
type: string
260
- enum: [ 'abs', 'absolute', 'display-absolute', 'absolute-sum', 'null2zero', 'percentage', 'unaligned' ]
382
+ enum:
383
+ - abs
384
+ - absolute
385
+ - display-absolute
386
+ - absolute-sum
387
+ - null2zero
388
+ - percentage
389
+ - unaligned
390
collectionFormat: pipes
262
- default: ['absolute']
391
+ default:
392
+ - absolute
393
allowEmptyValue: true
394
- name: label
395
in: query
266
- description: 'a text to be used as the label'
396
+ description: A text to be used as the label.
397
required: false
398
type: string
269
- format: 'any text'
399
+ format: any text
400
allowEmptyValue: true
401
- name: units
402
in: query
273
- description: 'a text to be used as the units'
403
+ description: A text to be used as the units.
404
required: false
405
type: string
276
- format: 'any text'
406
+ format: any text
407
allowEmptyValue: true
408
- name: label_color
409
in: query
280
- description: 'a color to be used for the background of the label'
410
+ description: A color to be used for the background of the label.
411
required: false
412
type: string
283
- format: 'any text'
413
+ format: any text
414
allowEmptyValue: true
415
- name: value_color
416
in: query
287
- description: 'a color to be used for the background of the label. You can set multiple using a pipe with a condition each, like this: color<value|color>value|color:null The following operators are supported: >, <, >=, <=, =, :null (to check if no value exists).'
417
+ description: >-
418
+ A color to be used for the background of the label. You can set
419
+ multiple using a pipe with a condition each, like this:
420
+ color<value|color>value|color:null The following operators are
421
+ supported: >, <, >=, <=, =, :null (to check if no value exists).
422
required: false
423
type: string
290
- format: 'any text'
424
+ format: any text
425
allowEmptyValue: true
426
- name: multiply
427
in: query
294
- description: 'multiply the value with this number for rendering it at the image (integer value required)'
428
+ description: >-
429
+ Multiply the value with this number for rendering it at the image
430
+ (integer value required).
431
required: false
432
type: number
433
format: integer
434
allowEmptyValue: true
435
- name: divide
436
in: query
301
- description: 'divide the value with this number for rendering it at the image (integer value required)'
437
+ description: >-
438
+ Divide the value with this number for rendering it at the image
439
+ (integer value required).
440
required: false
441
type: number
442
format: integer
443
allowEmptyValue: true
444
- name: scale
445
in: query
308
- description: 'set the scale of the badge (greater or equal to 100)'
446
+ description: Set the scale of the badge (greater or equal to 100).
447
required: false
448
type: number
449
format: integer
450
allowEmptyValue: true
451
responses:
452
'200':
315
- description: 'The call was successful. The response should be an SVG image.'
453
+ description: The call was successful. The response should be an SVG image.
454
'400':
317
- description: 'Bad request - the body will include a message stating what is wrong.'
455
+ description: Bad request - the body will include a message stating what is wrong.
456
'404':
319
- description: 'No chart with the given id is found.'
457
+ description: No chart with the given id is found.
458
'500':
321
- description: 'Internal server error. This usually means the server is out of memory.'
459
+ description: >-
460
+ Internal server error. This usually means the server is out of
461
+ memory.
462
/allmetrics:
463
get:
324
- summary: 'Get a value of all the metrics maintained by netdata'
325
- description: 'The charts endpoint returns the latest value of all charts and dimensions stored in the netdata server.'
464
+ summary: Get a value of all the metrics maintained by netdata
465
+ description: >-
466
+ The allmetrics endpoint returns the latest value of all charts and
467
+ dimensions stored in the netdata server.
468
parameters:
469
- name: format
470
in: query
329
- description: 'The format of the response to be returned'
471
+ description: The format of the response to be returned.
472
required: true
473
type: string
332
- enum: [ 'shell', 'prometheus', 'prometheus_all_hosts', 'json' ]
333
- default: 'shell'
474
+ enum:
475
+ - shell
476
+ - prometheus
477
+ - prometheus_all_hosts
478
+ - json
479
+ default: shell
480
- name: help
481
in: query
336
- description: 'enable or disable HELP lines in prometheus output'
482
+ description: Enable or disable HELP lines in prometheus output.
483
required: false
484
type: string
339
- enum: [ 'yes', 'no' ]
485
+ enum:
486
+ - 'yes'
487
+ - 'no'
488
default: 'no'
489
- name: types
490
in: query
343
- description: 'enable or disable TYPE lines in prometheus output'
491
+ description: Enable or disable TYPE lines in prometheus output.
492
required: false
493
type: string
346
- enum: [ 'yes', 'no' ]
494
+ enum:
495
+ - 'yes'
496
+ - 'no'
497
default: 'no'
498
- name: timestamps
499
in: query
350
- description: 'enable or disable timestamps in prometheus output'
500
+ description: Enable or disable timestamps in prometheus output.
501
required: false
502
type: string
353
- enum: [ 'yes', 'no' ]
503
+ enum:
504
+ - 'yes'
505
+ - 'no'
506
default: 'yes'
507
- name: names
508
in: query
357
- description: 'When enabled netdata will report dimension names. When disabled netdata will report dimension IDs. The default is controlled in netdata.conf.'
509
+ description: >-
510
+ When enabled netdata will report dimension names. When disabled
511
+ netdata will report dimension IDs. The default is controlled in
512
+ netdata.conf.
513
required: false
514
type: string
360
- enum: [ 'yes', 'no' ]
515
+ enum:
516
+ - 'yes'
517
+ - 'no'
518
default: 'yes'
519
- name: oldunits
520
in: query
364
- description: 'When enabled, netdata will show metric names for the default source=average as they appeared before 1.12, by using the legacy unit naming conventions'
521
+ description: >-
522
+ When enabled, netdata will show metric names for the default
523
+ source=average as they appeared before 1.12, by using the legacy
524
+ unit naming conventions.
525
required: false
526
type: string
367
- enum: [ 'yes', 'no' ]
527
+ enum:
528
+ - 'yes'
529
+ - 'no'
530
default: 'yes'
531
- name: hideunits
532
in: query
371
- description: 'When enabled, netdata will not include the units in the metric names, for the default source=average.'
533
+ description: >-
534
+ When enabled, netdata will not include the units in the metric
535
+ names, for the default source=average.
536
required: false
537
type: string
374
- enum: [ 'yes', 'no' ]
538
+ enum:
539
+ - 'yes'
540
+ - 'no'
541
default: 'yes'
542
- name: server
543
in: query
378
- description: 'Set a distinct name of the client querying prometheus metrics. Netdata will use the client IP if this is not set.'
544
+ description: >-
545
+ Set a distinct name of the client querying prometheus metrics.
546
+ Netdata will use the client IP if this is not set.
547
required: false
548
type: string
381
- format: 'any text'
549
+ format: any text
550
- name: prefix
551
in: query
384
- description: 'Prefix all prometheus metrics with this string.'
552
+ description: Prefix all prometheus metrics with this string.
553
required: false
554
type: string
387
- format: 'any text'
555
+ format: any text
556
- name: data
557
in: query
390
- description: 'Select the prometheus response data source. The default is controlled in netdata.conf'
558
+ description: >-
559
+ Select the prometheus response data source. There is a setting in
560
+ netdata.conf for the default.
561
required: false
562
type: string
393
- enum: [ 'as-collected', 'average', 'sum' ]
394
- default: 'average'
563
+ enum:
564
+ - as-collected
565
+ - average
566
+ - sum
567
+ default: average
568
responses:
569
'200':
397
- description: 'All the metrics returned in the format requested'
570
+ description: All the metrics returned in the format requested.
571
'400':
399
- description: 'The format requested is not supported'
572
+ description: The format requested is not supported.
573
/alarms:
574
get:
402
- summary: 'Get a list of active or raised alarms on the server'
403
- description: 'The alarms endpoint returns the list of all raised or enabled alarms on the netdata server. Called without any parameters, the raised alarms in state WARNING or CRITICAL are returned. By passing "?all", all the enabled alarms are returned.'
575
+ summary: Get a list of active or raised alarms on the server
576
+ description: >-
577
+ The alarms endpoint returns the list of all raised or enabled alarms on
578
+ the netdata server. Called without any parameters, the raised alarms in
579
+ state WARNING or CRITICAL are returned. By passing "?all", all the
580
+ enabled alarms are returned.
581
parameters:
582
- name: all
583
in: query
407
- description: 'If passed, all enabled alarms are returned'
584
+ description: 'If passed, all enabled alarms are returned.'
585
required: false
586
type: boolean
587
allowEmptyValue: true
588
responses:
589
'200':
413
- description: 'An object containing general info and a linked list of alarms'
590
+ description: An object containing general info and a linked list of alarms.
591
schema:
592
$ref: '#/definitions/alarms'
593
/alarm_log:
594
get:
418
- summary: 'Retrieves the entries of the alarm log'
419
- description: 'Returns an array of alarm_log entries, with historical information on raised and cleared alarms.'
595
+ summary: Retrieves the entries of the alarm log
596
+ description: >-
597
+ Returns an array of alarm_log entries, with historical information on
598
+ raised and cleared alarms.
599
parameters:
600
- name: after
601
in: query
423
- description: 'Passing the parameter after=UNIQUEID returns all the events in the alarm log that occurred after UNIQUEID. An automated series of calls would call the interface once without after=, store the last UNIQUEID of the returned set, and give it back to get incrementally the next events'
602
+ description: >-
603
+ Passing the parameter after=UNIQUEID returns all the events in the
604
+ alarm log that occurred after UNIQUEID. An automated series of calls
605
+ would call the interface once without after=, store the last
606
+ UNIQUEID of the returned set, and give it back to get incrementally
607
+ the next events.
608
required: false
609
type: integer
610
responses:
611
'200':
428
- description: 'An array of alarm log entries'
612
+ description: An array of alarm log entries.
613
schema:
614
type: array
615
items:
616
$ref: '#/definitions/alarm_log_entry'
617
/alarm_count:
618
get:
435
- summary: 'Get an overall status of the chart'
436
- description: "Checks multiple charts with the same context and counts number of alarms with given status."
619
+ summary: Get an overall status of the chart
620
+ description: >-
621
+ Checks multiple charts with the same context and counts number of alarms
622
+ with given status.
623
parameters:
624
- in: query
625
name: context
440
- description: "Specify context which should be checked"
626
+ description: Specify context which should be checked.
627
required: false
628
allowEmptyValue: true
629
type: array
630
items:
631
type: string
632
collectionFormat: pipes
447
- default: ['system.cpu']
633
+ default:
634
+ - system.cpu
635
- in: query
636
name: status
450
- description: "Specify alarm status to count"
637
+ description: Specify alarm status to count.
638
required: false
639
allowEmptyValue: true
640
type: string
454
- enum: ['REMOVED', 'UNDEFINED', 'UNINITIALIZED', 'CLEAR', 'RAISED', 'WARNING', 'CRITICAL']
455
- default: 'RAISED'
641
+ enum:
642
+ - REMOVED
643
+ - UNDEFINED
644
+ - UNINITIALIZED
645
+ - CLEAR
646
+ - RAISED
647
+ - WARNING
648
+ - CRITICAL
649
+ default: RAISED
650
responses:
651
'200':
458
- description: 'An object containing a count of alarms with given status for given contexts'
652
+ description: >-
653
+ An object containing a count of alarms with given status for given
654
+ contexts.
655
schema:
656
type: array
461
- items:
657
+ items:
658
type: number
659
'500':
464
- description: 'Internal server error. This usually means the server is out of memory.'
660
+ description: >-
661
+ Internal server error. This usually means the server is out of
662
+ memory.
663
/manage/health:
664
get:
467
- summary: 'Accesses the health management API to control health checks and notifications at runtime.'
468
- description: 'Available from Netdata v1.12 and above, protected via bearer authorization. Especially useful for maintenance periods, the API allows you to disable health checks completely, silence alarm notifications, or Disable/Silence specific alarms that match selectors on alarm/template name, chart, context, host and family. For the simple disable/silence all scenaria, only the cmd parameter is required. The other parameters are used to define alarm selectors. For more information and examples, refer to the netdata documentation.'
665
+ summary: >-
666
+ Accesses the health management API to control health checks and
667
+ notifications at runtime.
668
+ description: >-
669
+ Available from Netdata v1.12 and above, protected via bearer
670
+ authorization. Especially useful for maintenance periods, the API allows
671
+ you to disable health checks completely, silence alarm notifications, or
672
+ Disable/Silence specific alarms that match selectors on alarm/template
673
+ name, chart, context, host and family. For the simple disable/silence
674
+ all scenaria, only the cmd parameter is required. The other parameters
675
+ are used to define alarm selectors. For more information and examples,
676
+ refer to the netdata documentation.
677
parameters:
678
- name: cmd
679
in: query
472
- description: 'DISABLE ALL: No alarm criteria are evaluated, nothing is written in the alarm log. SILENCE ALL: No notifications are sent. RESET: Return to the default state. DISABLE/SILENCE: Set the mode to be used for the alarms matching the criteria of the alarm selectors. LIST: Show active configuration.'
680
+ description: >-
681
+ DISABLE ALL: No alarm criteria are evaluated, nothing is written in
682
+ the alarm log. SILENCE ALL: No notifications are sent. RESET: Return
683
+ to the default state. DISABLE/SILENCE: Set the mode to be used for
684
+ the alarms matching the criteria of the alarm selectors. LIST: Show
685
+ active configuration.
686
required: false
687
type: string
475
- enum: ['DISABLE ALL', 'SILENCE ALL', 'DISABLE', 'SILENCE', 'RESET', 'LIST']
688
+ enum:
689
+ - DISABLE ALL
690
+ - SILENCE ALL
691
+ - DISABLE
692
+ - SILENCE
693
+ - RESET
694
+ - LIST
695
- name: alarm
696
in: query
478
- description: 'The expression provided will match both `alarm` and `template` names.'
697
+ description: >-
698
+ The expression provided will match both `alarm` and `template`
699
+ names.
700
type: string
701
- name: chart
702
in: query
482
- description: 'Chart ids/names, as shown on the dashboard. These will match the `on` entry of a configured `alarm`'
703
+ description: >-
704
+ Chart ids/names, as shown on the dashboard. These will match the
705
+ `on` entry of a configured `alarm`.
706
type: string
707
- name: context
708
in: query
486
- description: 'Chart context, as shown on the dashboard. These will match the `on` entry of a configured `template`.'
487
- type: string
709
+ description: >-
710
+ Chart context, as shown on the dashboard. These will match the `on`
711
+ entry of a configured `template`.
712
+ type: string
713
- name: hosts
714
in: query
490
- description: 'The hostnames that will need to match.'
491
- type: string
715
+ description: The hostnames that will need to match.
716
+ type: string
717
- name: families
718
in: query
494
- description: 'The alarm families.'
495
- type: string
719
+ description: The alarm families.
720
+ type: string
721
responses:
722
'200':
498
- description: 'A plain text response based on the result of the command'
723
+ description: A plain text response based on the result of the command.
724
'403':
500
- description: 'Bearer authentication error.'
725
+ description: Bearer authentication error.
726
definitions:
727
info:
728
type: object
@@ -512,7 +737,7 @@ definitions:
737
example: 24e9fe3c-f2ac-11e8-bafc-0242ac110002
738
mirrored_hosts:
739
type: array
515
- description: list of hosts mirrored of the server (include itself).
740
+ description: List of hosts mirrored of the server (include itself).
741
items:
742
type: string
743
example:
@@ -520,169 +745,215 @@ definitions:
745
- host2.example.com
746
os_name:
747
type: string
523
- description: Operating System Name
524
- example: Manjaro Linux
748
+ description: Operating System Name.
749
+ example: Manjaro Linux
750
os_id:
751
type: string
527
- description: Operating System ID
752
+ description: Operating System ID.
753
example: manjaro
754
os_id_like:
755
type: string
531
- description: Known OS similar to this OS
756
+ description: Known OS similar to this OS.
757
example: arch
758
os_version:
759
type: string
535
- description: Operating System Version
760
+ description: Operating System Version.
761
example: 18.0.4
762
os_version_id:
763
type: string
539
- description: Operating System Version ID
764
+ description: Operating System Version ID.
765
example: unknown
766
os_detection:
767
type: string
543
- description: OS parameters detection method
768
+ description: OS parameters detection method.
769
example: Mixed
770
kernel_name:
771
type: string
547
- description: Kernel Name
772
+ description: Kernel Name.
773
example: Linux
774
kernel_version:
775
type: string
551
- description: Kernel Version
776
+ description: Kernel Version.
777
example: 4.19.32-1-MANJARO
778
architecture:
779
type: string
555
- description: Kernel architecture
780
+ description: Kernel architecture.
781
example: x86_64
782
virtualization:
783
type: string
559
- description: Virtualization Type
784
+ description: Virtualization Type.
785
example: kvm
786
virt_detection:
787
type: string
563
- description: Virtualization detection method
788
+ description: Virtualization detection method.
789
example: systemd-detect-virt
790
container:
791
type: string
567
- description: Container technology
792
+ description: Container technology.
793
example: docker
794
container_detection:
795
type: string
571
- description: Container technology detection method
796
+ description: Container technology detection method.
797
example: dockerenv
798
collectors:
799
type: array
800
items:
801
type: object
577
- description: Array of collector plugins and modules
802
+ description: Array of collector plugins and modules.
803
properties:
804
plugin:
805
type: string
581
- description: Collector plugin
806
+ description: Collector plugin.
807
example: python.d.plugin
808
module:
809
type: string
585
- description: Module of the collector plugin
810
+ description: Module of the collector plugin.
811
example: dockerd
812
alarms:
813
type: object
589
- description: number of alarms in the server.
814
+ description: Number of alarms in the server.
815
properties:
816
normal:
817
type: integer
593
- description: number of alarms in normal state.
818
+ description: Number of alarms in normal state.
819
warning:
820
type: integer
596
- description: number of alarms in warning state.
821
+ description: Number of alarms in warning state.
822
critical:
823
type: integer
599
- description: number of alarms in critical state.
824
+ description: Number of alarms in critical state.
825
chart_summary:
826
type: object
827
properties:
828
hostname:
829
type: string
605
- description: 'The hostname of the netdata server.'
830
+ description: The hostname of the netdata server.
831
version:
832
type: string
608
- description: 'netdata version of the server.'
833
+ description: netdata version of the server.
834
+ release_channel:
835
+ type: string
836
+ description: The release channel of the build on the server.
837
+ example: nightly
838
+ timezone:
839
+ type: string
840
+ description: The current timezone on the server.
841
os:
842
type: string
611
- description: 'The netdata server host operating system.'
612
- enum: [ 'macos', 'linux', 'freebsd' ]
843
+ description: The netdata server host operating system.
844
+ enum:
845
+ - macos
846
+ - linux
847
+ - freebsd
848
history:
849
type: number
615
- description: 'The duration, in seconds, of the round robin database maintained by netdata.'
850
+ description: >-
851
+ The duration, in seconds, of the round robin database maintained by
852
+ netdata.
853
+ memory_mode:
854
+ type: string
855
+ description: The name of the database memory mode on the server.
856
update_every:
857
type: number
618
- description: 'The default update frequency of the netdata server. All charts have an update frequency equal or bigger than this.'
858
+ description: >-
859
+ The default update frequency of the netdata server. All charts have an
860
+ update frequency equal or bigger than this.
861
charts:
862
type: object
621
- description: 'An object containing all the chart objects available at the netdata server. This is used as an indexed array. The key of each chart object is the id of the chart.'
863
+ description: >-
864
+ An object containing all the chart objects available at the netdata
865
+ server. This is used as an indexed array. The key of each chart object
866
+ is the id of the chart.
867
properties:
868
key:
869
$ref: '#/definitions/chart'
870
charts_count:
871
type: number
627
- description: 'The number of charts.'
872
+ description: The number of charts.
873
dimensions_count:
874
type: number
630
- description: 'The total number of dimensions.'
875
+ description: The total number of dimensions.
876
alarms_count:
877
type: number
633
- description: 'The number of alarms.'
878
+ description: The number of alarms.
879
rrd_memory_bytes:
880
type: number
636
- description: 'The size of the round robin database in bytes.'
881
+ description: The size of the round robin database in bytes.
882
chart:
883
type: object
884
properties:
885
id:
886
type: string
642
- description: 'The unique id of the chart'
887
+ description: The unique id of the chart.
888
name:
889
type: string
645
- description: 'The name of the chart'
890
+ description: The name of the chart.
891
type:
892
type: string
648
- description: 'The type of the chart. Types are not handled by netdata. You can use this field for anything you like.'
893
+ description: >-
894
+ The type of the chart. Types are not handled by netdata. You can use
895
+ this field for anything you like.
896
family:
897
type: string
651
- description: 'The family of the chart. Families are not handled by netdata. You can use this field for anything you like.'
898
+ description: >-
899
+ The family of the chart. Families are not handled by netdata. You can
900
+ use this field for anything you like.
901
title:
902
type: string
654
- description: 'The title of the chart.'
903
+ description: The title of the chart.
904
priority:
905
type: string
657
- description: 'The relative priority of the chart. NetData does not care about priorities. This is just an indication of importance for the chart viewers to sort charts of higher priority (lower number) closer to the top. Priority sorting should only be used among charts of the same type or family.'
906
+ description: >-
907
+ The relative priority of the chart. NetData does not care about
908
+ priorities. This is just an indication of importance for the chart
909
+ viewers to sort charts of higher priority (lower number) closer to the
910
+ top. Priority sorting should only be used among charts of the same
911
+ type or family.
912
enabled:
913
type: boolean
660
- description: 'True when the chart is enabled. Disabled charts do not currently collect values, but they may have historical values available.'
914
+ description: >-
915
+ True when the chart is enabled. Disabled charts do not currently
916
+ collect values, but they may have historical values available.
917
units:
918
type: string
663
- description: 'The unit of measurement for the values of all dimensions of the chart.'
919
+ description: The unit of measurement for the values of all dimensions of the chart.
920
data_url:
921
type: string
666
- description: 'The absolute path to get data values for this chart. You are expected to use this path as the base when constructing the URL to fetch data values for this chart.'
922
+ description: >-
923
+ The absolute path to get data values for this chart. You are expected
924
+ to use this path as the base when constructing the URL to fetch data
925
+ values for this chart.
926
chart_type:
927
type: string
669
- description: 'The chart type.'
670
- enum: [ 'line', 'area', 'stacked' ]
928
+ description: The chart type.
929
+ enum:
930
+ - line
931
+ - area
932
+ - stacked
933
duration:
934
type: number
673
- description: 'The duration, in seconds, of the round robin database maintained by netdata.'
935
+ description: >-
936
+ The duration, in seconds, of the round robin database maintained by
937
+ netdata.
938
first_entry:
939
type: number
676
- description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database.'
940
+ description: >-
941
+ The UNIX timestamp of the first entry (the oldest) in the round robin
942
+ database.
943
last_entry:
944
type: number
679
- description: 'The UNIX timestamp of the latest entry in the round robin database.'
945
+ description: The UNIX timestamp of the latest entry in the round robin database.
946
update_every:
947
type: number
682
- description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database.'
948
+ description: >-
949
+ The update frequency of this chart, in seconds. One value every this
950
+ amount of time is kept in the round robin database.
951
dimensions:
952
type: object
685
- description: 'An object containing all the chart dimensions available for the chart. This is used as an indexed array. The key of the object the id of the dimension.'
953
+ description: >-
954
+ An object containing all the chart dimensions available for the chart.
955
+ This is used as an indexed array. The key of the object the id of the
956
+ dimension.
957
properties:
958
key:
959
$ref: '#/definitions/dimension'
@@ -693,28 +964,30 @@ definitions:
964
$ref: '#/definitions/chart_variables'
965
green:
966
type: number
696
- description: 'Chart health green threshold'
967
+ description: Chart health green threshold.
968
red:
969
type: number
699
- description: 'Chart health red trheshold'
970
+ description: Chart health red threshold.
971
alarm_variables:
972
type: object
973
properties:
974
chart:
975
type: string
705
- description: 'The unique id of the chart'
976
+ description: The unique id of the chart.
977
chart_name:
978
type: string
708
- description: 'The name of the chart'
979
+ description: The name of the chart.
980
cnart_context:
981
type: string
711
- description: 'The context of the chart. It is shared across multiple monitored software or hardware instances and used in alarm templates'
982
+ description: >-
983
+ The context of the chart. It is shared across multiple monitored
984
+ software or hardware instances and used in alarm templates.
985
family:
986
type: string
714
- description: 'The family of the chart.'
987
+ description: The family of the chart.
988
host:
989
type: string
717
- description: 'The host containing the chart.'
990
+ description: The host containing the chart.
991
chart_variables:
992
type: object
993
properties:
@@ -752,192 +1025,317 @@ definitions:
1025
properties:
1026
name:
1027
type: string
755
- description: 'The name of the dimension'
756
- json_wrap:
1028
+ description: The name of the dimension.
1029
+ data:
1030
type: object
1031
+ discriminator: format
1032
+ description: >-
1033
+ Response will contain the appropriate subtype, e.g. data_json depending on
1034
+ the requested format.
1035
properties:
1036
api:
1037
type: number
761
- description: 'The API version this conforms to, currently 1'
1038
+ description: 'The API version this conforms to, currently 1.'
1039
id:
1040
type: string
764
- description: 'The unique id of the chart'
1041
+ description: The unique id of the chart.
1042
name:
1043
type: string
767
- description: 'The name of the chart'
1044
+ description: The name of the chart.
1045
update_every:
1046
type: number
770
- description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database (indepedently of the current view).'
1047
+ description: >-
1048
+ The update frequency of this chart, in seconds. One value every this
1049
+ amount of time is kept in the round robin database (indepedently of
1050
+ the current view).
1051
view_update_every:
1052
type: number
773
- description: 'The current view appropriate update frequency of this chart, in seconds. There is no point to request chart refreshes, using the same settings, more frequently than this.'
1053
+ description: >-
1054
+ The current view appropriate update frequency of this chart, in
1055
+ seconds. There is no point to request chart refreshes, using the same
1056
+ settings, more frequently than this.
1057
first_entry:
1058
type: number
776
- description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database (indepedently of the current view).'
1059
+ description: >-
1060
+ The UNIX timestamp of the first entry (the oldest) in the round robin
1061
+ database (indepedently of the current view).
1062
last_entry:
1063
type: number
779
- description: 'The UNIX timestamp of the latest entry in the round robin database (indepedently of the current view).'
1064
+ description: >-
1065
+ The UNIX timestamp of the latest entry in the round robin database
1066
+ (indepedently of the current view).
1067
after:
1068
type: number
782
- description: 'The UNIX timestamp of the first entry (the oldest) returned in this response.'
1069
+ description: >-
1070
+ The UNIX timestamp of the first entry (the oldest) returned in this
1071
+ response.
1072
before:
1073
type: number
785
- description: 'The UNIX timestamp of the latest entry returned in this response.'
1074
+ description: The UNIX timestamp of the latest entry returned in this response.
1075
min:
1076
type: number
788
- description: 'The minimum value returned in the current view. This can be used to size the y-series of the chart.'
1077
+ description: >-
1078
+ The minimum value returned in the current view. This can be used to
1079
+ size the y-series of the chart.
1080
max:
1081
type: number
791
- description: 'The maximum value returned in the current view. This can be used to size the y-series of the chart.'
1082
+ description: >-
1083
+ The maximum value returned in the current view. This can be used to
1084
+ size the y-series of the chart.
1085
dimension_names:
793
- description: 'The dimension names of the chart as returned in the current view.'
1086
+ description: The dimension names of the chart as returned in the current view.
1087
type: array
1088
items:
1089
type: string
1090
dimension_ids:
798
- description: 'The dimension IDs of the chart as returned in the current view.'
1091
+ description: The dimension IDs of the chart as returned in the current view.
1092
type: array
1093
items:
1094
type: string
1095
latest_values:
803
- description: 'The latest values collected for the chart (indepedently of the current view).'
1096
+ description: >-
1097
+ The latest values collected for the chart (indepedently of the current
1098
+ view).
1099
type: array
1100
items:
1101
type: string
1102
view_latest_values:
808
- description: 'The latest values returned with this response.'
1103
+ description: The latest values returned with this response.
1104
type: array
1105
items:
1106
type: string
1107
dimensions:
1108
type: number
814
- description: 'The number of dimensions returned.'
1109
+ description: The number of dimensions returned.
1110
points:
1111
type: number
817
- description: 'The number of rows / points returned.'
1112
+ description: The number of rows / points returned.
1113
format:
1114
type: string
820
- description: 'The format of the result returned.'
1115
+ description: The format of the result returned.
1116
chart_variables:
1117
type: object
1118
properties:
1119
key:
1120
$ref: '#/definitions/chart_variables'
826
- result:
827
- description: 'The result requested, in the format requested.'
1121
+ data_json:
1122
+ description: Data response in json format.
1123
+ allOf:
1124
+ - $ref: '#/definitions/data'
1125
+ - properties:
1126
+ result:
1127
+ type: object
1128
+ properties:
1129
+ labels:
1130
+ description: The dimensions retrieved from the chart.
1131
+ type: array
1132
+ items:
1133
+ type: string
1134
+ data:
1135
+ description: >-
1136
+ The data requested, one element per sample with each element
1137
+ containing the values of the dimensions described in the
1138
+ labels value.
1139
+ type: array
1140
+ items:
1141
+ type: number
1142
+ description: 'The result requested, in the format requested.'
1143
+ data_flat:
1144
+ description: >-
1145
+ Data response in csv / tsv / tsv-excel / ssv / ssv-comma / markdown / html
1146
+ formats.
1147
+ allOf:
1148
+ - $ref: '#/definitions/data'
1149
+ - properties:
1150
+ result:
1151
+ type: string
1152
+ data_array:
1153
+ description: Data response in array format.
1154
+ allOf:
1155
+ - $ref: '#/definitions/data'
1156
+ - properties:
1157
+ result:
1158
+ type: array
1159
+ items:
1160
+ type: number
1161
+ data_csvjsonarray:
1162
+ description: Data response in csvjsonarray format.
1163
+ allOf:
1164
+ - $ref: '#/definitions/data'
1165
+ - properties:
1166
+ result:
1167
+ description: >-
1168
+ The first inner array contains strings showing the labels of each
1169
+ column, each subsequent array contains the values for each point
1170
+ in time.
1171
+ type: array
1172
+ items:
1173
+ type: array
1174
+ items: {}
1175
+ data_datatable:
1176
+ description: >-
1177
+ Data response in datatable / datasource formats (suitable for Google
1178
+ Charts).
1179
+ allOf:
1180
+ - $ref: '#/definitions/data'
1181
+ - properties:
1182
+ result:
1183
+ type: object
1184
+ properties:
1185
+ cols:
1186
+ type: array
1187
+ items:
1188
+ type: object
1189
+ properties:
1190
+ id:
1191
+ description: Always empty - for future use.
1192
+ label:
1193
+ description: The dimension returned from the chart.
1194
+ pattern:
1195
+ description: Always empty - for future use.
1196
+ type:
1197
+ description: The type of data in the column / chart-dimension.
1198
+ p:
1199
+ description: Contains any annotations for the column.
1200
+ required:
1201
+ - id
1202
+ - label
1203
+ - pattern
1204
+ - type
1205
+ rows:
1206
+ type: array
1207
+ items:
1208
+ type: object
1209
+ properties:
1210
+ c:
1211
+ type: array
1212
+ items:
1213
+ properties:
1214
+ v:
1215
+ description: >-
1216
+ Each value in the row is represented by an object
1217
+ named `c` with five v fields: data, null, null, 0,
1218
+ the value. This format is fixed by the Google
1219
+ Charts API.
1220
alarms:
1221
type: object
830
- properties:
831
- hostname:
1222
+ properties:
1223
+ hostname:
1224
type: string
833
- latest_alarm_log_unique_id:
1225
+ latest_alarm_log_unique_id:
1226
type: integer
1227
format: int32
836
- status:
1228
+ status:
1229
type: boolean
838
- now:
1230
+ now:
1231
type: integer
1232
format: int32
841
- alarms:
1233
+ alarms:
1234
type: object
843
- properties:
844
- chart-name.alarm-name:
1235
+ properties:
1236
+ chart-name.alarm-name:
1237
type: object
846
- properties:
847
- id:
1238
+ properties:
1239
+ id:
1240
type: integer
1241
format: int32
850
- name:
1242
+ name:
1243
type: string
852
- description: Full alarm name
853
- chart:
1244
+ description: Full alarm name.
1245
+ chart:
1246
type: string
855
- family:
1247
+ family:
1248
type: string
857
- active:
1249
+ active:
1250
type: boolean
859
- description: Will be false only if the alarm is disabled in the configuration
860
- disabled:
1251
+ description: >-
1252
+ Will be false only if the alarm is disabled in the
1253
+ configuration.
1254
+ disabled:
1255
type: boolean
862
- description: Whether the health check for this alarm has been disabled via a health command API DISABLE command.
863
- silenced:
1256
+ description: >-
1257
+ Whether the health check for this alarm has been disabled via
1258
+ a health command API DISABLE command.
1259
+ silenced:
1260
type: boolean
865
- description: Whether notifications for this alarm have been silenced via a health command API SILENCE command.
866
- exec:
1261
+ description: >-
1262
+ Whether notifications for this alarm have been silenced via a
1263
+ health command API SILENCE command.
1264
+ exec:
1265
type: string
868
- recipient:
1266
+ recipient:
1267
type: string
870
- source:
1268
+ source:
1269
type: string
872
- units:
1270
+ units:
1271
type: string
874
- info:
1272
+ info:
1273
type: string
876
- status:
1274
+ status:
1275
type: string
878
- last_status_change:
1276
+ last_status_change:
1277
type: integer
1278
format: int32
881
- last_updated:
1279
+ last_updated:
1280
type: integer
1281
format: int32
884
- next_update:
1282
+ next_update:
1283
type: integer
1284
format: int32
887
- update_every:
1285
+ update_every:
1286
type: integer
1287
format: int32
890
- delay_up_duration:
1288
+ delay_up_duration:
1289
type: integer
1290
format: int32
893
- delay_down_duration:
1291
+ delay_down_duration:
1292
type: integer
1293
format: int32
896
- delay_max_duration:
1294
+ delay_max_duration:
1295
type: integer
1296
format: int32
899
- delay_multiplier:
1297
+ delay_multiplier:
1298
type: integer
1299
format: int32
902
- delay:
1300
+ delay:
1301
type: integer
1302
format: int32
905
- delay_up_to_timestamp:
1303
+ delay_up_to_timestamp:
1304
type: integer
1305
format: int32
908
- value_string:
1306
+ value_string:
1307
type: string
910
- no_clear_notification:
1308
+ no_clear_notification:
1309
type: boolean
912
- lookup_dimensions:
1310
+ lookup_dimensions:
1311
type: string
914
- db_after:
1312
+ db_after:
1313
type: integer
1314
format: int32
917
- db_before:
1315
+ db_before:
1316
type: integer
1317
format: int32
920
- lookup_method:
1318
+ lookup_method:
1319
type: string
922
- lookup_after:
1320
+ lookup_after:
1321
type: integer
1322
format: int32
925
- lookup_before:
1323
+ lookup_before:
1324
type: integer
1325
format: int32
928
- lookup_options:
1326
+ lookup_options:
1327
type: string
930
- calc:
1328
+ calc:
1329
type: string
932
- calc_parsed:
1330
+ calc_parsed:
1331
type: string
934
- warn:
1332
+ warn:
1333
type: string
936
- warn_parsed:
1334
+ warn_parsed:
1335
type: string
938
- crit:
1336
+ crit:
1337
type: string
940
- crit_parsed:
1338
+ crit_parsed:
1339
type: string
1340
warn_repeat_every:
1341
type: integer
@@ -945,90 +1343,90 @@ definitions:
1343
crit_repeat_every:
1344
type: integer
1345
format: int32
948
- green:
1346
+ green:
1347
type: string
1348
format: nullable
951
- red:
1349
+ red:
1350
type: string
1351
format: nullable
954
- value:
1352
+ value:
1353
type: number
1354
alarm_log_entry:
1355
type: object
958
- properties:
959
- hostname:
1356
+ properties:
1357
+ hostname:
1358
type: string
961
- unique_id:
1359
+ unique_id:
1360
type: integer
1361
format: int32
964
- alarm_id:
1362
+ alarm_id:
1363
type: integer
1364
format: int32
967
- alarm_event_id:
1365
+ alarm_event_id:
1366
type: integer
1367
format: int32
970
- name:
1368
+ name:
1369
type: string
972
- chart:
1370
+ chart:
1371
type: string
974
- family:
1372
+ family:
1373
type: string
976
- processed:
1374
+ processed:
1375
type: boolean
978
- updated:
1376
+ updated:
1377
type: boolean
980
- exec_run:
1378
+ exec_run:
1379
type: integer
1380
format: int32
983
- exec_failed:
1381
+ exec_failed:
1382
type: boolean
985
- exec:
1383
+ exec:
1384
type: string
987
- recipient:
1385
+ recipient:
1386
type: string
989
- exec_code:
1387
+ exec_code:
1388
type: integer
1389
format: int32
992
- source:
1390
+ source:
1391
type: string
994
- units:
1392
+ units:
1393
type: string
996
- when:
1394
+ when:
1395
type: integer
1396
format: int32
999
- duration:
1397
+ duration:
1398
type: integer
1399
format: int32
1002
- non_clear_duration:
1400
+ non_clear_duration:
1401
type: integer
1402
format: int32
1005
- status:
1403
+ status:
1404
type: string
1007
- old_status:
1405
+ old_status:
1406
type: string
1009
- delay:
1407
+ delay:
1408
type: integer
1409
format: int32
1012
- delay_up_to_timestamp:
1410
+ delay_up_to_timestamp:
1411
type: integer
1412
format: int32
1015
- updated_by_id:
1413
+ updated_by_id:
1414
type: integer
1415
format: int32
1018
- updates_id:
1416
+ updates_id:
1417
type: integer
1418
format: int32
1021
- value_string:
1419
+ value_string:
1420
type: string
1023
- old_value_string:
1421
+ old_value_string:
1422
type: string
1025
- silenced:
1423
+ silenced:
1424
type: string
1027
- info:
1425
+ info:
1426
type: string
1029
- value:
1427
+ value:
1428
type: string
1429
format: nullable
1032
- old_value:
1430
+ old_value:
1431
type: string
1432
format: nullable