@itentialopensource/adapter-thruk_monitoring 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +635 -22
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +257 -429
- package/adapterBase.js +549 -879
- package/metadata.json +47 -0
- package/package.json +24 -25
- package/pronghorn.json +980 -641
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +2656 -0
- package/report/adapter-openapi.yaml +2332 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691508933044.json +120 -0
- package/report/updateReport1692202249790.json +120 -0
- package/report/updateReport1692203343592.json +120 -0
- package/report/updateReport1694469545834.json +120 -0
- package/report/updateReport1698423037978.json +120 -0
- package/sampleProperties.json +63 -2
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +338 -112
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- package/workflows/README.md +0 -3
|
@@ -0,0 +1,2656 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"contact": {},
|
|
5
|
+
"license": {
|
|
6
|
+
"name": "Apache 2.0",
|
|
7
|
+
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
|
8
|
+
},
|
|
9
|
+
"description": "Thruk Monitoring - Thruk offers a rest api to expose various aspects of Thruk itself and livestatus information.",
|
|
10
|
+
"version": "1.0.0",
|
|
11
|
+
"title": "Thruk"
|
|
12
|
+
},
|
|
13
|
+
"servers": [
|
|
14
|
+
{
|
|
15
|
+
"url": "https://your.host.name.io/"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"security": [],
|
|
19
|
+
"paths": {
|
|
20
|
+
"/alerts": {
|
|
21
|
+
"get": {
|
|
22
|
+
"parameters": [],
|
|
23
|
+
"tags": [
|
|
24
|
+
"default"
|
|
25
|
+
],
|
|
26
|
+
"operationId": "getAlerts",
|
|
27
|
+
"summary": "Get Alerts",
|
|
28
|
+
"description": "lists alerts based on logfiles",
|
|
29
|
+
"responses": {
|
|
30
|
+
"200": {
|
|
31
|
+
"description": "successful operation"
|
|
32
|
+
},
|
|
33
|
+
"400": {
|
|
34
|
+
"description": "failed operation"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"/checks/stats": {
|
|
40
|
+
"get": {
|
|
41
|
+
"parameters": [],
|
|
42
|
+
"tags": [
|
|
43
|
+
"default"
|
|
44
|
+
],
|
|
45
|
+
"operationId": "getStatistics",
|
|
46
|
+
"summary": "Get Statistics",
|
|
47
|
+
"description": "lists host / service check statistics.",
|
|
48
|
+
"responses": {
|
|
49
|
+
"200": {
|
|
50
|
+
"description": "successful operation"
|
|
51
|
+
},
|
|
52
|
+
"400": {
|
|
53
|
+
"description": "failed operation"
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"/cmd": {
|
|
59
|
+
"post": {
|
|
60
|
+
"parameters": [],
|
|
61
|
+
"requestBody": {
|
|
62
|
+
"description": "body",
|
|
63
|
+
"required": true,
|
|
64
|
+
"content": {
|
|
65
|
+
"*/*": {
|
|
66
|
+
"schema": {
|
|
67
|
+
"type": "object"
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"tags": [
|
|
73
|
+
"default"
|
|
74
|
+
],
|
|
75
|
+
"operationId": "postCommand",
|
|
76
|
+
"summary": "Post Command",
|
|
77
|
+
"description": "Sends any command.",
|
|
78
|
+
"responses": {
|
|
79
|
+
"200": {
|
|
80
|
+
"description": "successful operation"
|
|
81
|
+
},
|
|
82
|
+
"400": {
|
|
83
|
+
"description": "failed operation"
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"/commands": {
|
|
89
|
+
"get": {
|
|
90
|
+
"parameters": [],
|
|
91
|
+
"tags": [
|
|
92
|
+
"default"
|
|
93
|
+
],
|
|
94
|
+
"operationId": "getCommands",
|
|
95
|
+
"summary": "Get Commands",
|
|
96
|
+
"description": "lists livestatus commands. see https://www.naemon.org/documentation/usersguide/livestatus.html#commands for details.",
|
|
97
|
+
"responses": {
|
|
98
|
+
"200": {
|
|
99
|
+
"description": "successful operation"
|
|
100
|
+
},
|
|
101
|
+
"400": {
|
|
102
|
+
"description": "failed operation"
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"/commands/{name}": {
|
|
108
|
+
"get": {
|
|
109
|
+
"parameters": [
|
|
110
|
+
{
|
|
111
|
+
"name": "name",
|
|
112
|
+
"in": "path",
|
|
113
|
+
"description": "name",
|
|
114
|
+
"required": true,
|
|
115
|
+
"schema": {
|
|
116
|
+
"type": "string"
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
],
|
|
120
|
+
"tags": [
|
|
121
|
+
"default"
|
|
122
|
+
],
|
|
123
|
+
"operationId": "getCommand",
|
|
124
|
+
"summary": "Get Command",
|
|
125
|
+
"description": "lists commands for given name. alias for /commands?name=<name>",
|
|
126
|
+
"responses": {
|
|
127
|
+
"200": {
|
|
128
|
+
"description": "successful operation"
|
|
129
|
+
},
|
|
130
|
+
"400": {
|
|
131
|
+
"description": "failed operation"
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
},
|
|
136
|
+
"/commands/{name}/config": {
|
|
137
|
+
"get": {
|
|
138
|
+
"parameters": [
|
|
139
|
+
{
|
|
140
|
+
"name": "name",
|
|
141
|
+
"in": "path",
|
|
142
|
+
"description": "name",
|
|
143
|
+
"schema": {
|
|
144
|
+
"type": "string"
|
|
145
|
+
},
|
|
146
|
+
"required": true
|
|
147
|
+
}
|
|
148
|
+
],
|
|
149
|
+
"tags": [
|
|
150
|
+
"default"
|
|
151
|
+
],
|
|
152
|
+
"operationId": "getCommandConfig",
|
|
153
|
+
"summary": "Get Command Config",
|
|
154
|
+
"description": "Returns configuration for given command. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#command",
|
|
155
|
+
"responses": {
|
|
156
|
+
"200": {
|
|
157
|
+
"description": "successful operation"
|
|
158
|
+
},
|
|
159
|
+
"400": {
|
|
160
|
+
"description": "failed operation"
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
"post": {
|
|
165
|
+
"parameters": [
|
|
166
|
+
{
|
|
167
|
+
"name": "name",
|
|
168
|
+
"in": "path",
|
|
169
|
+
"description": "name",
|
|
170
|
+
"required": true,
|
|
171
|
+
"schema": {
|
|
172
|
+
"type": "string"
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
],
|
|
176
|
+
"requestBody": {
|
|
177
|
+
"description": "body",
|
|
178
|
+
"required": true,
|
|
179
|
+
"content": {
|
|
180
|
+
"*/*": {
|
|
181
|
+
"schema": {
|
|
182
|
+
"type": "object"
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"tags": [
|
|
188
|
+
"default"
|
|
189
|
+
],
|
|
190
|
+
"operationId": "postCommandConfig",
|
|
191
|
+
"summary": "Post Command Config",
|
|
192
|
+
"description": "Replace command configuration completely, use PATCH to only update specific attributes.",
|
|
193
|
+
"responses": {
|
|
194
|
+
"200": {
|
|
195
|
+
"description": "successful operation"
|
|
196
|
+
},
|
|
197
|
+
"400": {
|
|
198
|
+
"description": "failed operation"
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"patch": {
|
|
203
|
+
"parameters": [
|
|
204
|
+
{
|
|
205
|
+
"name": "name",
|
|
206
|
+
"in": "path",
|
|
207
|
+
"description": "name",
|
|
208
|
+
"required": true,
|
|
209
|
+
"schema": {
|
|
210
|
+
"type": "string"
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
],
|
|
214
|
+
"requestBody": {
|
|
215
|
+
"description": "body",
|
|
216
|
+
"required": true,
|
|
217
|
+
"content": {
|
|
218
|
+
"*/*": {
|
|
219
|
+
"schema": {
|
|
220
|
+
"type": "object"
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
},
|
|
225
|
+
"tags": [
|
|
226
|
+
"default"
|
|
227
|
+
],
|
|
228
|
+
"operationId": "patchCommandConfig",
|
|
229
|
+
"summary": "Patch Command Config",
|
|
230
|
+
"description": "Update command configuration partially.",
|
|
231
|
+
"responses": {
|
|
232
|
+
"200": {
|
|
233
|
+
"description": "successful operation"
|
|
234
|
+
},
|
|
235
|
+
"400": {
|
|
236
|
+
"description": "failed operation"
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
},
|
|
240
|
+
"delete": {
|
|
241
|
+
"parameters": [
|
|
242
|
+
{
|
|
243
|
+
"name": "name",
|
|
244
|
+
"in": "path",
|
|
245
|
+
"description": "name",
|
|
246
|
+
"required": true,
|
|
247
|
+
"schema": {
|
|
248
|
+
"type": "string"
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
],
|
|
252
|
+
"tags": [
|
|
253
|
+
"default"
|
|
254
|
+
],
|
|
255
|
+
"operationId": "deleteCommandConfig",
|
|
256
|
+
"summary": "Delete Command Cofig",
|
|
257
|
+
"description": "Deletes given command from configuration.",
|
|
258
|
+
"responses": {
|
|
259
|
+
"200": {
|
|
260
|
+
"description": "successful operation"
|
|
261
|
+
},
|
|
262
|
+
"400": {
|
|
263
|
+
"description": "failed operation"
|
|
264
|
+
}
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
},
|
|
268
|
+
"/comments": {
|
|
269
|
+
"get": {
|
|
270
|
+
"parameters": [],
|
|
271
|
+
"tags": [
|
|
272
|
+
"default"
|
|
273
|
+
],
|
|
274
|
+
"operationId": "getComments",
|
|
275
|
+
"summary": "Get Comments",
|
|
276
|
+
"description": "lists livestatus comments. see https://www.naemon.org/documentation/usersguide/livestatus.html#comments for details.",
|
|
277
|
+
"responses": {
|
|
278
|
+
"200": {
|
|
279
|
+
"description": "successful operation"
|
|
280
|
+
},
|
|
281
|
+
"400": {
|
|
282
|
+
"description": "failed operation"
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
}
|
|
286
|
+
},
|
|
287
|
+
"/comments/{id}": {
|
|
288
|
+
"get": {
|
|
289
|
+
"parameters": [
|
|
290
|
+
{
|
|
291
|
+
"name": "id",
|
|
292
|
+
"in": "path",
|
|
293
|
+
"description": "id",
|
|
294
|
+
"schema": {
|
|
295
|
+
"type": "string"
|
|
296
|
+
},
|
|
297
|
+
"required": true
|
|
298
|
+
}
|
|
299
|
+
],
|
|
300
|
+
"tags": [
|
|
301
|
+
"default"
|
|
302
|
+
],
|
|
303
|
+
"operationId": "getComment",
|
|
304
|
+
"summary": "Get Comment",
|
|
305
|
+
"description": "lists comments for given id. alias for /comments?id=<id>",
|
|
306
|
+
"responses": {
|
|
307
|
+
"200": {
|
|
308
|
+
"description": "successful operation"
|
|
309
|
+
},
|
|
310
|
+
"400": {
|
|
311
|
+
"description": "failed operation"
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
},
|
|
316
|
+
"/config/check": {
|
|
317
|
+
"post": {
|
|
318
|
+
"parameters": [],
|
|
319
|
+
"tags": [
|
|
320
|
+
"default"
|
|
321
|
+
],
|
|
322
|
+
"operationId": "postConfigCheck",
|
|
323
|
+
"summary": "Post Config Check",
|
|
324
|
+
"description": "Returns result from config check. This check does require changes to be saved to disk before running the check.",
|
|
325
|
+
"responses": {
|
|
326
|
+
"200": {
|
|
327
|
+
"description": "successful operation"
|
|
328
|
+
},
|
|
329
|
+
"400": {
|
|
330
|
+
"description": "failed operation"
|
|
331
|
+
}
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
},
|
|
335
|
+
"/config/diff": {
|
|
336
|
+
"get": {
|
|
337
|
+
"parameters": [],
|
|
338
|
+
"tags": [
|
|
339
|
+
"default"
|
|
340
|
+
],
|
|
341
|
+
"operationId": "getConfigDiff",
|
|
342
|
+
"summary": "Get Config Diff",
|
|
343
|
+
"description": "Returns differences between filesystem and stashed config changes.",
|
|
344
|
+
"responses": {
|
|
345
|
+
"200": {
|
|
346
|
+
"description": "successful operation"
|
|
347
|
+
},
|
|
348
|
+
"400": {
|
|
349
|
+
"description": "failed operation"
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
},
|
|
354
|
+
"/config/discard": {
|
|
355
|
+
"post": {
|
|
356
|
+
"parameters": [],
|
|
357
|
+
"tags": [
|
|
358
|
+
"default"
|
|
359
|
+
],
|
|
360
|
+
"operationId": "postConfigDiscard",
|
|
361
|
+
"summary": "Post Config Discard",
|
|
362
|
+
"description": "Reverts stashed configuration changes. Alias for /config/revert",
|
|
363
|
+
"responses": {
|
|
364
|
+
"200": {
|
|
365
|
+
"description": "successful operation"
|
|
366
|
+
},
|
|
367
|
+
"400": {
|
|
368
|
+
"description": "failed operation"
|
|
369
|
+
}
|
|
370
|
+
}
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
"/config/files": {
|
|
374
|
+
"get": {
|
|
375
|
+
"parameters": [],
|
|
376
|
+
"tags": [
|
|
377
|
+
"default"
|
|
378
|
+
],
|
|
379
|
+
"operationId": "getConfigFiles",
|
|
380
|
+
"summary": "Get Config Files",
|
|
381
|
+
"description": "returns all config files",
|
|
382
|
+
"responses": {
|
|
383
|
+
"200": {
|
|
384
|
+
"description": "successful operation"
|
|
385
|
+
},
|
|
386
|
+
"400": {
|
|
387
|
+
"description": "failed operation"
|
|
388
|
+
}
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"/config/fullobjects": {
|
|
393
|
+
"get": {
|
|
394
|
+
"parameters": [],
|
|
395
|
+
"tags": [
|
|
396
|
+
"default"
|
|
397
|
+
],
|
|
398
|
+
"operationId": "getConfigFullObjects",
|
|
399
|
+
"summary": "Get Config Full Objects",
|
|
400
|
+
"description": "Returns list of all objects with templates expanded. Used templates are saved to the :TEMPLATES attribute",
|
|
401
|
+
"responses": {
|
|
402
|
+
"200": {
|
|
403
|
+
"description": "successful operation"
|
|
404
|
+
},
|
|
405
|
+
"400": {
|
|
406
|
+
"description": "failed operation"
|
|
407
|
+
}
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
},
|
|
411
|
+
"/config/objects": {
|
|
412
|
+
"get": {
|
|
413
|
+
"parameters": [],
|
|
414
|
+
"tags": [
|
|
415
|
+
"default"
|
|
416
|
+
],
|
|
417
|
+
"operationId": "Get Config Objects",
|
|
418
|
+
"summary": "Get Config Objects",
|
|
419
|
+
"description": "Returns list of all objects with their raw config. Use /config/fullobjects to get the full expanded config.",
|
|
420
|
+
"responses": {
|
|
421
|
+
"200": {
|
|
422
|
+
"description": "successful operation"
|
|
423
|
+
},
|
|
424
|
+
"400": {
|
|
425
|
+
"description": "failed operation"
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
},
|
|
429
|
+
"post": {
|
|
430
|
+
"parameters": [],
|
|
431
|
+
"requestBody": {
|
|
432
|
+
"description": "body",
|
|
433
|
+
"required": true,
|
|
434
|
+
"content": {
|
|
435
|
+
"*/*": {
|
|
436
|
+
"schema": {
|
|
437
|
+
"type": "object"
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
},
|
|
442
|
+
"tags": [
|
|
443
|
+
"default"
|
|
444
|
+
],
|
|
445
|
+
"operationId": "postConfigObjects",
|
|
446
|
+
"summary": "Post Config Objects",
|
|
447
|
+
"description": "Create new object. Besides the actual object config, requires 2 special paramters :FILE and :TYPE.",
|
|
448
|
+
"responses": {
|
|
449
|
+
"200": {
|
|
450
|
+
"description": "successful operation"
|
|
451
|
+
},
|
|
452
|
+
"400": {
|
|
453
|
+
"description": "failed operation"
|
|
454
|
+
}
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"patch": {
|
|
458
|
+
"parameters": [],
|
|
459
|
+
"requestBody": {
|
|
460
|
+
"description": "body",
|
|
461
|
+
"required": true,
|
|
462
|
+
"content": {
|
|
463
|
+
"*/*": {
|
|
464
|
+
"schema": {
|
|
465
|
+
"type": "object"
|
|
466
|
+
}
|
|
467
|
+
}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
"tags": [
|
|
471
|
+
"default"
|
|
472
|
+
],
|
|
473
|
+
"operationId": "patchConfigObjects",
|
|
474
|
+
"summary": "Patch Config Objects",
|
|
475
|
+
"description": "Change attributes for all matching objects. This is a very powerful url, for example you could change all hosts which have max_check_attempts=3 to max_check_attempts=5 with this command:",
|
|
476
|
+
"responses": {
|
|
477
|
+
"200": {
|
|
478
|
+
"description": "successful operation"
|
|
479
|
+
},
|
|
480
|
+
"400": {
|
|
481
|
+
"description": "failed operation"
|
|
482
|
+
}
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
},
|
|
486
|
+
"/config/objects/{id}": {
|
|
487
|
+
"patch": {
|
|
488
|
+
"parameters": [
|
|
489
|
+
{
|
|
490
|
+
"name": "id",
|
|
491
|
+
"in": "path",
|
|
492
|
+
"description": "id",
|
|
493
|
+
"required": true,
|
|
494
|
+
"schema": {
|
|
495
|
+
"type": "string"
|
|
496
|
+
}
|
|
497
|
+
}
|
|
498
|
+
],
|
|
499
|
+
"requestBody": {
|
|
500
|
+
"description": "body",
|
|
501
|
+
"required": true,
|
|
502
|
+
"content": {
|
|
503
|
+
"*/*": {
|
|
504
|
+
"schema": {
|
|
505
|
+
"type": "object"
|
|
506
|
+
}
|
|
507
|
+
}
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
"tags": [
|
|
511
|
+
"default"
|
|
512
|
+
],
|
|
513
|
+
"operationId": "patchConfigObject",
|
|
514
|
+
"summary": "Patch Config Object",
|
|
515
|
+
"description": "Update object configuration partially.",
|
|
516
|
+
"responses": {
|
|
517
|
+
"200": {
|
|
518
|
+
"description": "successful operation"
|
|
519
|
+
},
|
|
520
|
+
"400": {
|
|
521
|
+
"description": "failed operation"
|
|
522
|
+
}
|
|
523
|
+
}
|
|
524
|
+
},
|
|
525
|
+
"post": {
|
|
526
|
+
"parameters": [
|
|
527
|
+
{
|
|
528
|
+
"name": "id",
|
|
529
|
+
"in": "path",
|
|
530
|
+
"description": "id",
|
|
531
|
+
"required": true,
|
|
532
|
+
"schema": {
|
|
533
|
+
"type": "string"
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
],
|
|
537
|
+
"requestBody": {
|
|
538
|
+
"description": "body",
|
|
539
|
+
"required": true,
|
|
540
|
+
"content": {
|
|
541
|
+
"*/*": {
|
|
542
|
+
"schema": {
|
|
543
|
+
"type": "object"
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
"tags": [
|
|
549
|
+
"default"
|
|
550
|
+
],
|
|
551
|
+
"operationId": "postConfigObject",
|
|
552
|
+
"summary": "Post Config Object",
|
|
553
|
+
"description": "Replace object configuration completely.",
|
|
554
|
+
"responses": {
|
|
555
|
+
"200": {
|
|
556
|
+
"description": "successful operation"
|
|
557
|
+
},
|
|
558
|
+
"400": {
|
|
559
|
+
"description": "failed operation"
|
|
560
|
+
}
|
|
561
|
+
}
|
|
562
|
+
},
|
|
563
|
+
"delete": {
|
|
564
|
+
"parameters": [
|
|
565
|
+
{
|
|
566
|
+
"name": "name",
|
|
567
|
+
"in": "path",
|
|
568
|
+
"description": "name",
|
|
569
|
+
"required": true,
|
|
570
|
+
"schema": {
|
|
571
|
+
"type": "string"
|
|
572
|
+
}
|
|
573
|
+
}
|
|
574
|
+
],
|
|
575
|
+
"tags": [
|
|
576
|
+
"default"
|
|
577
|
+
],
|
|
578
|
+
"operationId": "deleteConfigObject",
|
|
579
|
+
"summary": "Delete Config Object",
|
|
580
|
+
"description": "Remove given object from configuration.",
|
|
581
|
+
"responses": {
|
|
582
|
+
"200": {
|
|
583
|
+
"description": "successful operation"
|
|
584
|
+
},
|
|
585
|
+
"400": {
|
|
586
|
+
"description": "failed operation"
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
"/config/precheck": {
|
|
592
|
+
"get": {
|
|
593
|
+
"parameters": [],
|
|
594
|
+
"tags": [
|
|
595
|
+
"default"
|
|
596
|
+
],
|
|
597
|
+
"operationId": "getConfigPrecheck",
|
|
598
|
+
"summary": "Get Config Pre Check",
|
|
599
|
+
"description": "Returns result from Thruks config precheck. The precheck does not require changes to be saved to disk before running the check.",
|
|
600
|
+
"responses": {
|
|
601
|
+
"200": {
|
|
602
|
+
"description": "successful operation"
|
|
603
|
+
},
|
|
604
|
+
"400": {
|
|
605
|
+
"description": "failed operation"
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
}
|
|
609
|
+
},
|
|
610
|
+
"/config/reload": {
|
|
611
|
+
"post": {
|
|
612
|
+
"parameters": [],
|
|
613
|
+
"tags": [
|
|
614
|
+
"default"
|
|
615
|
+
],
|
|
616
|
+
"operationId": "postConfigReload",
|
|
617
|
+
"summary": "Post Config Reload",
|
|
618
|
+
"description": "Reloads configuration with the configured reload command.",
|
|
619
|
+
"responses": {
|
|
620
|
+
"200": {
|
|
621
|
+
"description": "successful operation"
|
|
622
|
+
},
|
|
623
|
+
"400": {
|
|
624
|
+
"description": "failed operation"
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
}
|
|
628
|
+
},
|
|
629
|
+
"/config/revert": {
|
|
630
|
+
"post": {
|
|
631
|
+
"parameters": [],
|
|
632
|
+
"tags": [
|
|
633
|
+
"default"
|
|
634
|
+
],
|
|
635
|
+
"operationId": "postConfigRevert",
|
|
636
|
+
"summary": "Post Config Revert",
|
|
637
|
+
"description": "Reverts stashed configuration changes.",
|
|
638
|
+
"responses": {
|
|
639
|
+
"200": {
|
|
640
|
+
"description": "successful operation"
|
|
641
|
+
},
|
|
642
|
+
"400": {
|
|
643
|
+
"description": "failed operation"
|
|
644
|
+
}
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
},
|
|
648
|
+
"/config/save": {
|
|
649
|
+
"post": {
|
|
650
|
+
"parameters": [],
|
|
651
|
+
"tags": [
|
|
652
|
+
"default"
|
|
653
|
+
],
|
|
654
|
+
"operationId": "postConfigSave",
|
|
655
|
+
"summary": "Post Config Save",
|
|
656
|
+
"description": "Saves stashed configuration changes to disk.",
|
|
657
|
+
"responses": {
|
|
658
|
+
"200": {
|
|
659
|
+
"description": "successful operation"
|
|
660
|
+
},
|
|
661
|
+
"400": {
|
|
662
|
+
"description": "failed operation"
|
|
663
|
+
}
|
|
664
|
+
}
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
"/contactgroups": {
|
|
668
|
+
"get": {
|
|
669
|
+
"parameters": [],
|
|
670
|
+
"tags": [
|
|
671
|
+
"default"
|
|
672
|
+
],
|
|
673
|
+
"operationId": "getContactGroups",
|
|
674
|
+
"summary": "Get Contact Groups",
|
|
675
|
+
"description": "lists livestatus contactgroups. see https://www.naemon.org/documentation/usersguide/livestatus.html#contactgroups for details.",
|
|
676
|
+
"responses": {
|
|
677
|
+
"200": {
|
|
678
|
+
"description": "successful operation"
|
|
679
|
+
},
|
|
680
|
+
"400": {
|
|
681
|
+
"description": "failed operation"
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
}
|
|
685
|
+
},
|
|
686
|
+
"/contactgroups/{name}": {
|
|
687
|
+
"get": {
|
|
688
|
+
"parameters": [
|
|
689
|
+
{
|
|
690
|
+
"name": "name",
|
|
691
|
+
"in": "path",
|
|
692
|
+
"description": "name",
|
|
693
|
+
"required": true,
|
|
694
|
+
"schema": {
|
|
695
|
+
"type": "string"
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
],
|
|
699
|
+
"tags": [
|
|
700
|
+
"default"
|
|
701
|
+
],
|
|
702
|
+
"operationId": "getContactGroup",
|
|
703
|
+
"summary": "Get Contact Group",
|
|
704
|
+
"description": "lists contactgroups for given name. alias for /contactgroups?name=<name>",
|
|
705
|
+
"responses": {
|
|
706
|
+
"200": {
|
|
707
|
+
"description": "successful operation"
|
|
708
|
+
},
|
|
709
|
+
"400": {
|
|
710
|
+
"description": "failed operation"
|
|
711
|
+
}
|
|
712
|
+
}
|
|
713
|
+
}
|
|
714
|
+
},
|
|
715
|
+
"/contactgroups/{name}/config": {
|
|
716
|
+
"get": {
|
|
717
|
+
"parameters": [
|
|
718
|
+
{
|
|
719
|
+
"name": "name",
|
|
720
|
+
"in": "path",
|
|
721
|
+
"description": "name",
|
|
722
|
+
"schema": {
|
|
723
|
+
"type": "string"
|
|
724
|
+
},
|
|
725
|
+
"required": true
|
|
726
|
+
}
|
|
727
|
+
],
|
|
728
|
+
"tags": [
|
|
729
|
+
"default"
|
|
730
|
+
],
|
|
731
|
+
"operationId": "getContactGroupsConfig",
|
|
732
|
+
"summary": "Get Contact Groups Config",
|
|
733
|
+
"description": "Returns configuration for given contactgroup. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#contactgroup",
|
|
734
|
+
"responses": {
|
|
735
|
+
"200": {
|
|
736
|
+
"description": "successful operation"
|
|
737
|
+
},
|
|
738
|
+
"400": {
|
|
739
|
+
"description": "failed operation"
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
},
|
|
743
|
+
"post": {
|
|
744
|
+
"parameters": [
|
|
745
|
+
{
|
|
746
|
+
"name": "name",
|
|
747
|
+
"in": "path",
|
|
748
|
+
"description": "name",
|
|
749
|
+
"required": true,
|
|
750
|
+
"schema": {
|
|
751
|
+
"type": "string"
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
],
|
|
755
|
+
"requestBody": {
|
|
756
|
+
"description": "body",
|
|
757
|
+
"required": true,
|
|
758
|
+
"content": {
|
|
759
|
+
"*/*": {
|
|
760
|
+
"schema": {
|
|
761
|
+
"type": "object"
|
|
762
|
+
}
|
|
763
|
+
}
|
|
764
|
+
}
|
|
765
|
+
},
|
|
766
|
+
"tags": [
|
|
767
|
+
"default"
|
|
768
|
+
],
|
|
769
|
+
"operationId": "postContactGroupsConfig",
|
|
770
|
+
"summary": "Post Contact Groups Config",
|
|
771
|
+
"description": "Replace contactgroup configuration completely, use PATCH to only update specific attributes.",
|
|
772
|
+
"responses": {
|
|
773
|
+
"200": {
|
|
774
|
+
"description": "successful operation"
|
|
775
|
+
},
|
|
776
|
+
"400": {
|
|
777
|
+
"description": "failed operation"
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
},
|
|
781
|
+
"patch": {
|
|
782
|
+
"parameters": [
|
|
783
|
+
{
|
|
784
|
+
"name": "name",
|
|
785
|
+
"in": "path",
|
|
786
|
+
"description": "name",
|
|
787
|
+
"required": true,
|
|
788
|
+
"schema": {
|
|
789
|
+
"type": "string"
|
|
790
|
+
}
|
|
791
|
+
}
|
|
792
|
+
],
|
|
793
|
+
"requestBody": {
|
|
794
|
+
"description": "body",
|
|
795
|
+
"required": true,
|
|
796
|
+
"content": {
|
|
797
|
+
"*/*": {
|
|
798
|
+
"schema": {
|
|
799
|
+
"type": "object"
|
|
800
|
+
}
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
},
|
|
804
|
+
"tags": [
|
|
805
|
+
"default"
|
|
806
|
+
],
|
|
807
|
+
"operationId": "patchContactGroupsConfig",
|
|
808
|
+
"summary": "Patch Contact Groups Config",
|
|
809
|
+
"description": "Update contactgroup configuration partially.",
|
|
810
|
+
"responses": {
|
|
811
|
+
"200": {
|
|
812
|
+
"description": "successful operation"
|
|
813
|
+
},
|
|
814
|
+
"400": {
|
|
815
|
+
"description": "failed operation"
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
},
|
|
819
|
+
"delete": {
|
|
820
|
+
"parameters": [
|
|
821
|
+
{
|
|
822
|
+
"name": "name",
|
|
823
|
+
"in": "path",
|
|
824
|
+
"description": "name",
|
|
825
|
+
"required": true,
|
|
826
|
+
"schema": {
|
|
827
|
+
"type": "string"
|
|
828
|
+
}
|
|
829
|
+
}
|
|
830
|
+
],
|
|
831
|
+
"tags": [
|
|
832
|
+
"default"
|
|
833
|
+
],
|
|
834
|
+
"operationId": "deleteContactsGroupConfig",
|
|
835
|
+
"summary": "Delete Contact Groups Config",
|
|
836
|
+
"description": "Deletes given contactgroup from configuration.",
|
|
837
|
+
"responses": {
|
|
838
|
+
"200": {
|
|
839
|
+
"description": "successful operation"
|
|
840
|
+
},
|
|
841
|
+
"400": {
|
|
842
|
+
"description": "failed operation"
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
},
|
|
847
|
+
"/contacts": {
|
|
848
|
+
"get": {
|
|
849
|
+
"parameters": [],
|
|
850
|
+
"tags": [
|
|
851
|
+
"default"
|
|
852
|
+
],
|
|
853
|
+
"operationId": "getContacts",
|
|
854
|
+
"summary": "Get Contacts",
|
|
855
|
+
"description": "lists livestatus contacts. see https://www.naemon.org/documentation/usersguide/livestatus.html#contacts for details.",
|
|
856
|
+
"responses": {
|
|
857
|
+
"200": {
|
|
858
|
+
"description": "successful operation"
|
|
859
|
+
},
|
|
860
|
+
"400": {
|
|
861
|
+
"description": "failed operation"
|
|
862
|
+
}
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
},
|
|
866
|
+
"/contacts/{name}": {
|
|
867
|
+
"get": {
|
|
868
|
+
"parameters": [
|
|
869
|
+
{
|
|
870
|
+
"name": "name",
|
|
871
|
+
"in": "path",
|
|
872
|
+
"description": "name",
|
|
873
|
+
"required": true,
|
|
874
|
+
"schema": {
|
|
875
|
+
"type": "string"
|
|
876
|
+
}
|
|
877
|
+
}
|
|
878
|
+
],
|
|
879
|
+
"tags": [
|
|
880
|
+
"default"
|
|
881
|
+
],
|
|
882
|
+
"operationId": "getContact",
|
|
883
|
+
"summary": "Get Contact",
|
|
884
|
+
"description": "lists contacts for given name. alias for /contacts?name=<name>",
|
|
885
|
+
"responses": {
|
|
886
|
+
"200": {
|
|
887
|
+
"description": "successful operation"
|
|
888
|
+
},
|
|
889
|
+
"400": {
|
|
890
|
+
"description": "failed operation"
|
|
891
|
+
}
|
|
892
|
+
}
|
|
893
|
+
}
|
|
894
|
+
},
|
|
895
|
+
"/contacts/{name}/config": {
|
|
896
|
+
"get": {
|
|
897
|
+
"parameters": [
|
|
898
|
+
{
|
|
899
|
+
"name": "name",
|
|
900
|
+
"in": "path",
|
|
901
|
+
"description": "name",
|
|
902
|
+
"required": true,
|
|
903
|
+
"schema": {
|
|
904
|
+
"type": "string"
|
|
905
|
+
}
|
|
906
|
+
}
|
|
907
|
+
],
|
|
908
|
+
"tags": [
|
|
909
|
+
"default"
|
|
910
|
+
],
|
|
911
|
+
"operationId": "getContactConfig",
|
|
912
|
+
"summary": "Get Contact Config",
|
|
913
|
+
"description": "Returns configuration for given contact. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#contact",
|
|
914
|
+
"responses": {
|
|
915
|
+
"200": {
|
|
916
|
+
"description": "successful operation"
|
|
917
|
+
},
|
|
918
|
+
"400": {
|
|
919
|
+
"description": "failed operation"
|
|
920
|
+
}
|
|
921
|
+
}
|
|
922
|
+
},
|
|
923
|
+
"post": {
|
|
924
|
+
"parameters": [
|
|
925
|
+
{
|
|
926
|
+
"name": "name",
|
|
927
|
+
"in": "path",
|
|
928
|
+
"description": "name",
|
|
929
|
+
"required": true,
|
|
930
|
+
"schema": {
|
|
931
|
+
"type": "string"
|
|
932
|
+
}
|
|
933
|
+
}
|
|
934
|
+
],
|
|
935
|
+
"requestBody": {
|
|
936
|
+
"description": "body",
|
|
937
|
+
"required": true,
|
|
938
|
+
"content": {
|
|
939
|
+
"*/*": {
|
|
940
|
+
"schema": {
|
|
941
|
+
"type": "object"
|
|
942
|
+
}
|
|
943
|
+
}
|
|
944
|
+
}
|
|
945
|
+
},
|
|
946
|
+
"tags": [
|
|
947
|
+
"default"
|
|
948
|
+
],
|
|
949
|
+
"operationId": "postContactConfig",
|
|
950
|
+
"summary": "Post Contact Config",
|
|
951
|
+
"description": "Replace contact configuration completely, use PATCH to only update specific attributes.",
|
|
952
|
+
"responses": {
|
|
953
|
+
"200": {
|
|
954
|
+
"description": "successful operation"
|
|
955
|
+
},
|
|
956
|
+
"400": {
|
|
957
|
+
"description": "failed operation"
|
|
958
|
+
}
|
|
959
|
+
}
|
|
960
|
+
},
|
|
961
|
+
"patch": {
|
|
962
|
+
"parameters": [
|
|
963
|
+
{
|
|
964
|
+
"name": "name",
|
|
965
|
+
"in": "path",
|
|
966
|
+
"description": "name",
|
|
967
|
+
"schema": {
|
|
968
|
+
"type": "string"
|
|
969
|
+
},
|
|
970
|
+
"required": true
|
|
971
|
+
}
|
|
972
|
+
],
|
|
973
|
+
"requestBody": {
|
|
974
|
+
"description": "body",
|
|
975
|
+
"required": true,
|
|
976
|
+
"content": {
|
|
977
|
+
"*/*": {
|
|
978
|
+
"schema": {
|
|
979
|
+
"type": "object"
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
},
|
|
984
|
+
"tags": [
|
|
985
|
+
"default"
|
|
986
|
+
],
|
|
987
|
+
"operationId": "patchContactConfig",
|
|
988
|
+
"summary": "Patch Contact Config",
|
|
989
|
+
"description": "Update contact configuration partially.",
|
|
990
|
+
"responses": {
|
|
991
|
+
"200": {
|
|
992
|
+
"description": "successful operation"
|
|
993
|
+
},
|
|
994
|
+
"400": {
|
|
995
|
+
"description": "failed operation"
|
|
996
|
+
}
|
|
997
|
+
}
|
|
998
|
+
},
|
|
999
|
+
"delete": {
|
|
1000
|
+
"parameters": [
|
|
1001
|
+
{
|
|
1002
|
+
"name": "name",
|
|
1003
|
+
"in": "path",
|
|
1004
|
+
"description": "name",
|
|
1005
|
+
"required": true,
|
|
1006
|
+
"schema": {
|
|
1007
|
+
"type": "string"
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
],
|
|
1011
|
+
"tags": [
|
|
1012
|
+
"default"
|
|
1013
|
+
],
|
|
1014
|
+
"operationId": "deleteContactConfig",
|
|
1015
|
+
"summary": "Delete Contact Config",
|
|
1016
|
+
"description": "Deletes given contact from configuration.",
|
|
1017
|
+
"responses": {
|
|
1018
|
+
"200": {
|
|
1019
|
+
"description": "successful operation"
|
|
1020
|
+
},
|
|
1021
|
+
"400": {
|
|
1022
|
+
"description": "failed operation"
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
}
|
|
1026
|
+
},
|
|
1027
|
+
"/downtimes": {
|
|
1028
|
+
"get": {
|
|
1029
|
+
"parameters": [],
|
|
1030
|
+
"tags": [
|
|
1031
|
+
"default"
|
|
1032
|
+
],
|
|
1033
|
+
"operationId": "getDowntimes",
|
|
1034
|
+
"summary": "Get Downtimes",
|
|
1035
|
+
"description": "lists livestatus downtimes. see https://www.naemon.org/documentation/usersguide/livestatus.html#downtimes for details.",
|
|
1036
|
+
"responses": {
|
|
1037
|
+
"200": {
|
|
1038
|
+
"description": "successful operation"
|
|
1039
|
+
},
|
|
1040
|
+
"400": {
|
|
1041
|
+
"description": "failed operation"
|
|
1042
|
+
}
|
|
1043
|
+
}
|
|
1044
|
+
}
|
|
1045
|
+
},
|
|
1046
|
+
"/downtimes/{id}": {
|
|
1047
|
+
"get": {
|
|
1048
|
+
"parameters": [
|
|
1049
|
+
{
|
|
1050
|
+
"name": "id",
|
|
1051
|
+
"in": "path",
|
|
1052
|
+
"description": "id",
|
|
1053
|
+
"required": true,
|
|
1054
|
+
"schema": {
|
|
1055
|
+
"type": "string"
|
|
1056
|
+
}
|
|
1057
|
+
}
|
|
1058
|
+
],
|
|
1059
|
+
"tags": [
|
|
1060
|
+
"default"
|
|
1061
|
+
],
|
|
1062
|
+
"operationId": "getDowntime",
|
|
1063
|
+
"summary": "Get Downtime",
|
|
1064
|
+
"description": "lists downtimes for given id. alias for /downtimes?id=<id>",
|
|
1065
|
+
"responses": {
|
|
1066
|
+
"200": {
|
|
1067
|
+
"description": "successful operation"
|
|
1068
|
+
},
|
|
1069
|
+
"400": {
|
|
1070
|
+
"description": "failed operation"
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
"/hostgroups": {
|
|
1076
|
+
"get": {
|
|
1077
|
+
"parameters": [],
|
|
1078
|
+
"tags": [
|
|
1079
|
+
"default"
|
|
1080
|
+
],
|
|
1081
|
+
"operationId": "getHostgroups",
|
|
1082
|
+
"summary": "Get Hostgroups",
|
|
1083
|
+
"description": "lists livestatus hostgroups. see https://www.naemon.org/documentation/usersguide/livestatus.html#hostgroups for details.",
|
|
1084
|
+
"responses": {
|
|
1085
|
+
"200": {
|
|
1086
|
+
"description": "successful operation"
|
|
1087
|
+
},
|
|
1088
|
+
"400": {
|
|
1089
|
+
"description": "failed operation"
|
|
1090
|
+
}
|
|
1091
|
+
}
|
|
1092
|
+
}
|
|
1093
|
+
},
|
|
1094
|
+
"/hostgroups/{name}": {
|
|
1095
|
+
"get": {
|
|
1096
|
+
"parameters": [
|
|
1097
|
+
{
|
|
1098
|
+
"name": "name",
|
|
1099
|
+
"in": "path",
|
|
1100
|
+
"description": "name",
|
|
1101
|
+
"required": true,
|
|
1102
|
+
"schema": {
|
|
1103
|
+
"type": "string"
|
|
1104
|
+
}
|
|
1105
|
+
}
|
|
1106
|
+
],
|
|
1107
|
+
"tags": [
|
|
1108
|
+
"default"
|
|
1109
|
+
],
|
|
1110
|
+
"operationId": "getHostgroup",
|
|
1111
|
+
"summary": "Get Hostgroup",
|
|
1112
|
+
"description": "lists hostgroups for given name. alias for /hostgroups?name=<name>",
|
|
1113
|
+
"responses": {
|
|
1114
|
+
"200": {
|
|
1115
|
+
"description": "successful operation"
|
|
1116
|
+
},
|
|
1117
|
+
"400": {
|
|
1118
|
+
"description": "failed operation"
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
},
|
|
1123
|
+
"/hostgroups/{name}/config": {
|
|
1124
|
+
"get": {
|
|
1125
|
+
"parameters": [
|
|
1126
|
+
{
|
|
1127
|
+
"name": "name",
|
|
1128
|
+
"in": "path",
|
|
1129
|
+
"description": "name",
|
|
1130
|
+
"required": true,
|
|
1131
|
+
"schema": {
|
|
1132
|
+
"type": "string"
|
|
1133
|
+
}
|
|
1134
|
+
}
|
|
1135
|
+
],
|
|
1136
|
+
"tags": [
|
|
1137
|
+
"default"
|
|
1138
|
+
],
|
|
1139
|
+
"operationId": "getHostgroupConfig",
|
|
1140
|
+
"summary": "Get Hostgroup Config",
|
|
1141
|
+
"description": "Returns configuration for given hostgroup. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#hostgroup",
|
|
1142
|
+
"responses": {
|
|
1143
|
+
"200": {
|
|
1144
|
+
"description": "successful operation"
|
|
1145
|
+
},
|
|
1146
|
+
"400": {
|
|
1147
|
+
"description": "failed operation"
|
|
1148
|
+
}
|
|
1149
|
+
}
|
|
1150
|
+
},
|
|
1151
|
+
"post": {
|
|
1152
|
+
"parameters": [
|
|
1153
|
+
{
|
|
1154
|
+
"name": "name",
|
|
1155
|
+
"in": "path",
|
|
1156
|
+
"description": "name",
|
|
1157
|
+
"required": true,
|
|
1158
|
+
"schema": {
|
|
1159
|
+
"type": "string"
|
|
1160
|
+
}
|
|
1161
|
+
}
|
|
1162
|
+
],
|
|
1163
|
+
"requestBody": {
|
|
1164
|
+
"description": "body",
|
|
1165
|
+
"required": true,
|
|
1166
|
+
"content": {
|
|
1167
|
+
"*/*": {
|
|
1168
|
+
"schema": {
|
|
1169
|
+
"type": "object"
|
|
1170
|
+
}
|
|
1171
|
+
}
|
|
1172
|
+
}
|
|
1173
|
+
},
|
|
1174
|
+
"tags": [
|
|
1175
|
+
"default"
|
|
1176
|
+
],
|
|
1177
|
+
"operationId": "postHostgroupConfig",
|
|
1178
|
+
"summary": "Post Hostgroup Config",
|
|
1179
|
+
"description": "Replace hostgroups configuration completely, use PATCH to only update specific attributes.",
|
|
1180
|
+
"responses": {
|
|
1181
|
+
"200": {
|
|
1182
|
+
"description": "successful operation"
|
|
1183
|
+
},
|
|
1184
|
+
"400": {
|
|
1185
|
+
"description": "failed operation"
|
|
1186
|
+
}
|
|
1187
|
+
}
|
|
1188
|
+
},
|
|
1189
|
+
"patch": {
|
|
1190
|
+
"parameters": [
|
|
1191
|
+
{
|
|
1192
|
+
"name": "name",
|
|
1193
|
+
"in": "path",
|
|
1194
|
+
"description": "name",
|
|
1195
|
+
"required": true,
|
|
1196
|
+
"schema": {
|
|
1197
|
+
"type": "string"
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
],
|
|
1201
|
+
"requestBody": {
|
|
1202
|
+
"description": "body",
|
|
1203
|
+
"required": true,
|
|
1204
|
+
"content": {
|
|
1205
|
+
"*/*": {
|
|
1206
|
+
"schema": {
|
|
1207
|
+
"type": "object"
|
|
1208
|
+
}
|
|
1209
|
+
}
|
|
1210
|
+
}
|
|
1211
|
+
},
|
|
1212
|
+
"tags": [
|
|
1213
|
+
"default"
|
|
1214
|
+
],
|
|
1215
|
+
"operationId": "patchHostgroupConfig",
|
|
1216
|
+
"summary": "Patch Hostgroup Config",
|
|
1217
|
+
"description": "Update hostgroup configuration partially.",
|
|
1218
|
+
"responses": {
|
|
1219
|
+
"200": {
|
|
1220
|
+
"description": "successful operation"
|
|
1221
|
+
},
|
|
1222
|
+
"400": {
|
|
1223
|
+
"description": "failed operation"
|
|
1224
|
+
}
|
|
1225
|
+
}
|
|
1226
|
+
},
|
|
1227
|
+
"delete": {
|
|
1228
|
+
"parameters": [
|
|
1229
|
+
{
|
|
1230
|
+
"name": "name",
|
|
1231
|
+
"in": "path",
|
|
1232
|
+
"description": "name",
|
|
1233
|
+
"required": true,
|
|
1234
|
+
"schema": {
|
|
1235
|
+
"type": "string"
|
|
1236
|
+
}
|
|
1237
|
+
}
|
|
1238
|
+
],
|
|
1239
|
+
"tags": [
|
|
1240
|
+
"default"
|
|
1241
|
+
],
|
|
1242
|
+
"operationId": "deleteHostgroupConfig",
|
|
1243
|
+
"summary": "Delete Hostgroup Config",
|
|
1244
|
+
"description": "Deletes given hostgroup from configuration.",
|
|
1245
|
+
"responses": {
|
|
1246
|
+
"200": {
|
|
1247
|
+
"description": "successful operation"
|
|
1248
|
+
},
|
|
1249
|
+
"400": {
|
|
1250
|
+
"description": "failed operation"
|
|
1251
|
+
}
|
|
1252
|
+
}
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
"/hostgroups/{name}/outages": {
|
|
1256
|
+
"get": {
|
|
1257
|
+
"parameters": [
|
|
1258
|
+
{
|
|
1259
|
+
"name": "name",
|
|
1260
|
+
"in": "path",
|
|
1261
|
+
"description": "name ",
|
|
1262
|
+
"required": true,
|
|
1263
|
+
"schema": {
|
|
1264
|
+
"type": "string"
|
|
1265
|
+
}
|
|
1266
|
+
}
|
|
1267
|
+
],
|
|
1268
|
+
"tags": [
|
|
1269
|
+
"default"
|
|
1270
|
+
],
|
|
1271
|
+
"operationId": "getHostgroupOutages",
|
|
1272
|
+
"summary": "Get Hostgroup Outages",
|
|
1273
|
+
"description": "list of outages for this hostgroup.",
|
|
1274
|
+
"responses": {
|
|
1275
|
+
"200": {
|
|
1276
|
+
"description": "successful operation"
|
|
1277
|
+
},
|
|
1278
|
+
"400": {
|
|
1279
|
+
"description": "failed operation"
|
|
1280
|
+
}
|
|
1281
|
+
}
|
|
1282
|
+
}
|
|
1283
|
+
},
|
|
1284
|
+
"/hostgroups/{name}/stats": {
|
|
1285
|
+
"get": {
|
|
1286
|
+
"parameters": [
|
|
1287
|
+
{
|
|
1288
|
+
"name": "name",
|
|
1289
|
+
"in": "path",
|
|
1290
|
+
"description": "name",
|
|
1291
|
+
"required": true,
|
|
1292
|
+
"schema": {
|
|
1293
|
+
"type": "string"
|
|
1294
|
+
}
|
|
1295
|
+
}
|
|
1296
|
+
],
|
|
1297
|
+
"tags": [
|
|
1298
|
+
"default"
|
|
1299
|
+
],
|
|
1300
|
+
"operationId": "getHostgroupStats",
|
|
1301
|
+
"summary": "Get Hostgroup Stats",
|
|
1302
|
+
"description": "hash of livestatus hostgroup statistics. alias for /hosts/stats?groups[gte]=<name>",
|
|
1303
|
+
"responses": {
|
|
1304
|
+
"200": {
|
|
1305
|
+
"description": "successful operation"
|
|
1306
|
+
},
|
|
1307
|
+
"400": {
|
|
1308
|
+
"description": "failed operation"
|
|
1309
|
+
}
|
|
1310
|
+
}
|
|
1311
|
+
}
|
|
1312
|
+
},
|
|
1313
|
+
"/hosts": {
|
|
1314
|
+
"get": {
|
|
1315
|
+
"parameters": [],
|
|
1316
|
+
"tags": [
|
|
1317
|
+
"default"
|
|
1318
|
+
],
|
|
1319
|
+
"operationId": "getHosts",
|
|
1320
|
+
"summary": "Get Hosts",
|
|
1321
|
+
"description": "lists livestatus hosts. see https://www.naemon.org/documentation/usersguide/livestatus.html#hosts for details.",
|
|
1322
|
+
"responses": {
|
|
1323
|
+
"200": {
|
|
1324
|
+
"description": "successful operation"
|
|
1325
|
+
},
|
|
1326
|
+
"400": {
|
|
1327
|
+
"description": "failed operation"
|
|
1328
|
+
}
|
|
1329
|
+
}
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
"/hosts/{name}": {
|
|
1333
|
+
"get": {
|
|
1334
|
+
"parameters": [
|
|
1335
|
+
{
|
|
1336
|
+
"name": "name",
|
|
1337
|
+
"in": "path",
|
|
1338
|
+
"description": "name",
|
|
1339
|
+
"schema": {
|
|
1340
|
+
"type": "string"
|
|
1341
|
+
},
|
|
1342
|
+
"required": true
|
|
1343
|
+
}
|
|
1344
|
+
],
|
|
1345
|
+
"tags": [
|
|
1346
|
+
"default"
|
|
1347
|
+
],
|
|
1348
|
+
"operationId": "getHost",
|
|
1349
|
+
"summary": "Get Host",
|
|
1350
|
+
"description": "lists hosts for given name. alias for /hosts?name=<name>",
|
|
1351
|
+
"responses": {
|
|
1352
|
+
"200": {
|
|
1353
|
+
"description": "successful operation"
|
|
1354
|
+
},
|
|
1355
|
+
"400": {
|
|
1356
|
+
"description": "failed operation"
|
|
1357
|
+
}
|
|
1358
|
+
}
|
|
1359
|
+
}
|
|
1360
|
+
},
|
|
1361
|
+
"/hosts/{name}/alerts": {
|
|
1362
|
+
"get": {
|
|
1363
|
+
"parameters": [
|
|
1364
|
+
{
|
|
1365
|
+
"name": "name",
|
|
1366
|
+
"in": "path",
|
|
1367
|
+
"description": "name",
|
|
1368
|
+
"required": true,
|
|
1369
|
+
"schema": {
|
|
1370
|
+
"type": "string"
|
|
1371
|
+
}
|
|
1372
|
+
}
|
|
1373
|
+
],
|
|
1374
|
+
"tags": [
|
|
1375
|
+
"default"
|
|
1376
|
+
],
|
|
1377
|
+
"operationId": "getHostAlerts",
|
|
1378
|
+
"summary": "Get Host Alerts",
|
|
1379
|
+
"description": "lists alerts for given host. alias for /logs?type[~]=^(HOST|SERVICE) ALERT&host_name=<name>",
|
|
1380
|
+
"responses": {
|
|
1381
|
+
"200": {
|
|
1382
|
+
"description": "successful operation"
|
|
1383
|
+
},
|
|
1384
|
+
"400": {
|
|
1385
|
+
"description": "failed operation"
|
|
1386
|
+
}
|
|
1387
|
+
}
|
|
1388
|
+
}
|
|
1389
|
+
},
|
|
1390
|
+
"/hosts/{name}/commandline": {
|
|
1391
|
+
"get": {
|
|
1392
|
+
"parameters": [
|
|
1393
|
+
{
|
|
1394
|
+
"name": "name",
|
|
1395
|
+
"in": "path",
|
|
1396
|
+
"description": "name",
|
|
1397
|
+
"required": true,
|
|
1398
|
+
"schema": {
|
|
1399
|
+
"type": "string"
|
|
1400
|
+
}
|
|
1401
|
+
}
|
|
1402
|
+
],
|
|
1403
|
+
"tags": [
|
|
1404
|
+
"default"
|
|
1405
|
+
],
|
|
1406
|
+
"operationId": "getHostCommandLine",
|
|
1407
|
+
"summary": "Get Host Command Line",
|
|
1408
|
+
"description": "displays commandline for check command of given hosts.",
|
|
1409
|
+
"responses": {
|
|
1410
|
+
"200": {
|
|
1411
|
+
"description": "successful operation"
|
|
1412
|
+
},
|
|
1413
|
+
"400": {
|
|
1414
|
+
"description": "failed operation"
|
|
1415
|
+
}
|
|
1416
|
+
}
|
|
1417
|
+
}
|
|
1418
|
+
},
|
|
1419
|
+
"/hosts/{name}/config": {
|
|
1420
|
+
"get": {
|
|
1421
|
+
"parameters": [
|
|
1422
|
+
{
|
|
1423
|
+
"name": "name",
|
|
1424
|
+
"in": "path",
|
|
1425
|
+
"description": "name",
|
|
1426
|
+
"required": true,
|
|
1427
|
+
"schema": {
|
|
1428
|
+
"type": "string"
|
|
1429
|
+
}
|
|
1430
|
+
}
|
|
1431
|
+
],
|
|
1432
|
+
"tags": [
|
|
1433
|
+
"default"
|
|
1434
|
+
],
|
|
1435
|
+
"operationId": "getHostConfig",
|
|
1436
|
+
"summary": "Get Host Config",
|
|
1437
|
+
"description": "Returns configuration for given host. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#host",
|
|
1438
|
+
"responses": {
|
|
1439
|
+
"200": {
|
|
1440
|
+
"description": "successful operation"
|
|
1441
|
+
},
|
|
1442
|
+
"400": {
|
|
1443
|
+
"description": "failed operation"
|
|
1444
|
+
}
|
|
1445
|
+
}
|
|
1446
|
+
},
|
|
1447
|
+
"post": {
|
|
1448
|
+
"parameters": [
|
|
1449
|
+
{
|
|
1450
|
+
"name": "name",
|
|
1451
|
+
"in": "path",
|
|
1452
|
+
"description": "name",
|
|
1453
|
+
"required": true,
|
|
1454
|
+
"schema": {
|
|
1455
|
+
"type": "string"
|
|
1456
|
+
}
|
|
1457
|
+
}
|
|
1458
|
+
],
|
|
1459
|
+
"requestBody": {
|
|
1460
|
+
"description": "body",
|
|
1461
|
+
"required": true,
|
|
1462
|
+
"content": {
|
|
1463
|
+
"*/*": {
|
|
1464
|
+
"schema": {
|
|
1465
|
+
"type": "object"
|
|
1466
|
+
}
|
|
1467
|
+
}
|
|
1468
|
+
}
|
|
1469
|
+
},
|
|
1470
|
+
"tags": [
|
|
1471
|
+
"default"
|
|
1472
|
+
],
|
|
1473
|
+
"operationId": "postHostConfig",
|
|
1474
|
+
"summary": "Post Host Config",
|
|
1475
|
+
"description": "Replace host configuration completely, use PATCH to only update specific attributes.",
|
|
1476
|
+
"responses": {
|
|
1477
|
+
"200": {
|
|
1478
|
+
"description": "successful operation"
|
|
1479
|
+
},
|
|
1480
|
+
"400": {
|
|
1481
|
+
"description": "failed operation"
|
|
1482
|
+
}
|
|
1483
|
+
}
|
|
1484
|
+
},
|
|
1485
|
+
"patch": {
|
|
1486
|
+
"parameters": [
|
|
1487
|
+
{
|
|
1488
|
+
"name": "name",
|
|
1489
|
+
"in": "path",
|
|
1490
|
+
"description": "name",
|
|
1491
|
+
"required": true,
|
|
1492
|
+
"schema": {
|
|
1493
|
+
"type": "string"
|
|
1494
|
+
}
|
|
1495
|
+
}
|
|
1496
|
+
],
|
|
1497
|
+
"requestBody": {
|
|
1498
|
+
"description": "body",
|
|
1499
|
+
"required": true,
|
|
1500
|
+
"content": {
|
|
1501
|
+
"*/*": {
|
|
1502
|
+
"schema": {
|
|
1503
|
+
"type": "object"
|
|
1504
|
+
}
|
|
1505
|
+
}
|
|
1506
|
+
}
|
|
1507
|
+
},
|
|
1508
|
+
"tags": [
|
|
1509
|
+
"default"
|
|
1510
|
+
],
|
|
1511
|
+
"operationId": "patchHostConfig",
|
|
1512
|
+
"summary": "Patch Host Config",
|
|
1513
|
+
"description": "Update host configuration partially.",
|
|
1514
|
+
"responses": {
|
|
1515
|
+
"200": {
|
|
1516
|
+
"description": "successful operation"
|
|
1517
|
+
},
|
|
1518
|
+
"400": {
|
|
1519
|
+
"description": "failed operation"
|
|
1520
|
+
}
|
|
1521
|
+
}
|
|
1522
|
+
},
|
|
1523
|
+
"delete": {
|
|
1524
|
+
"parameters": [
|
|
1525
|
+
{
|
|
1526
|
+
"name": "name",
|
|
1527
|
+
"in": "path",
|
|
1528
|
+
"description": "name",
|
|
1529
|
+
"required": true,
|
|
1530
|
+
"schema": {
|
|
1531
|
+
"type": "string"
|
|
1532
|
+
}
|
|
1533
|
+
}
|
|
1534
|
+
],
|
|
1535
|
+
"tags": [
|
|
1536
|
+
"default"
|
|
1537
|
+
],
|
|
1538
|
+
"operationId": "deleteHostConfig",
|
|
1539
|
+
"summary": "Delete Host Config",
|
|
1540
|
+
"description": "Deletes given host from configuration.",
|
|
1541
|
+
"responses": {
|
|
1542
|
+
"200": {
|
|
1543
|
+
"description": "successful operation"
|
|
1544
|
+
},
|
|
1545
|
+
"400": {
|
|
1546
|
+
"description": "failed operation"
|
|
1547
|
+
}
|
|
1548
|
+
}
|
|
1549
|
+
}
|
|
1550
|
+
},
|
|
1551
|
+
"/hosts/{name}/notifications": {
|
|
1552
|
+
"get": {
|
|
1553
|
+
"parameters": [
|
|
1554
|
+
{
|
|
1555
|
+
"name": "name",
|
|
1556
|
+
"in": "path",
|
|
1557
|
+
"description": "name",
|
|
1558
|
+
"required": true,
|
|
1559
|
+
"schema": {
|
|
1560
|
+
"type": "string"
|
|
1561
|
+
}
|
|
1562
|
+
}
|
|
1563
|
+
],
|
|
1564
|
+
"tags": [
|
|
1565
|
+
"default"
|
|
1566
|
+
],
|
|
1567
|
+
"operationId": "getHostNotifications",
|
|
1568
|
+
"summary": "Get Host Notifications",
|
|
1569
|
+
"description": "lists notifications for given host. alias for /logs?class=3&host_name=<name>",
|
|
1570
|
+
"responses": {
|
|
1571
|
+
"200": {
|
|
1572
|
+
"description": "successful operation"
|
|
1573
|
+
},
|
|
1574
|
+
"400": {
|
|
1575
|
+
"description": "failed operation"
|
|
1576
|
+
}
|
|
1577
|
+
}
|
|
1578
|
+
}
|
|
1579
|
+
},
|
|
1580
|
+
"/hosts/{name}/outages": {
|
|
1581
|
+
"get": {
|
|
1582
|
+
"parameters": [
|
|
1583
|
+
{
|
|
1584
|
+
"name": "name",
|
|
1585
|
+
"in": "path",
|
|
1586
|
+
"description": "name",
|
|
1587
|
+
"required": true,
|
|
1588
|
+
"schema": {
|
|
1589
|
+
"type": "string"
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
],
|
|
1593
|
+
"tags": [
|
|
1594
|
+
"default"
|
|
1595
|
+
],
|
|
1596
|
+
"operationId": "getHostOutages",
|
|
1597
|
+
"summary": "Get Host Outages",
|
|
1598
|
+
"description": "list of outages for this host.",
|
|
1599
|
+
"responses": {
|
|
1600
|
+
"200": {
|
|
1601
|
+
"description": "successful operation"
|
|
1602
|
+
},
|
|
1603
|
+
"400": {
|
|
1604
|
+
"description": "failed operation"
|
|
1605
|
+
}
|
|
1606
|
+
}
|
|
1607
|
+
}
|
|
1608
|
+
},
|
|
1609
|
+
"/hosts/{name}/services": {
|
|
1610
|
+
"get": {
|
|
1611
|
+
"parameters": [
|
|
1612
|
+
{
|
|
1613
|
+
"name": "name",
|
|
1614
|
+
"in": "path",
|
|
1615
|
+
"description": "name",
|
|
1616
|
+
"required": true,
|
|
1617
|
+
"schema": {
|
|
1618
|
+
"type": "string"
|
|
1619
|
+
}
|
|
1620
|
+
}
|
|
1621
|
+
],
|
|
1622
|
+
"tags": [
|
|
1623
|
+
"default"
|
|
1624
|
+
],
|
|
1625
|
+
"operationId": "getHostServices",
|
|
1626
|
+
"summary": "Get Host Services",
|
|
1627
|
+
"description": "lists services for given host. alias for /services?host_name=<name>",
|
|
1628
|
+
"responses": {
|
|
1629
|
+
"200": {
|
|
1630
|
+
"description": "successful operation"
|
|
1631
|
+
},
|
|
1632
|
+
"400": {
|
|
1633
|
+
"description": "failed operation"
|
|
1634
|
+
}
|
|
1635
|
+
}
|
|
1636
|
+
}
|
|
1637
|
+
},
|
|
1638
|
+
"/hosts/outages": {
|
|
1639
|
+
"get": {
|
|
1640
|
+
"parameters": [],
|
|
1641
|
+
"tags": [
|
|
1642
|
+
"default"
|
|
1643
|
+
],
|
|
1644
|
+
"operationId": "getOutages",
|
|
1645
|
+
"summary": "Get Outages",
|
|
1646
|
+
"description": "list of outages for all hosts.",
|
|
1647
|
+
"responses": {
|
|
1648
|
+
"200": {
|
|
1649
|
+
"description": "successful operation"
|
|
1650
|
+
},
|
|
1651
|
+
"400": {
|
|
1652
|
+
"description": "failed operation"
|
|
1653
|
+
}
|
|
1654
|
+
}
|
|
1655
|
+
}
|
|
1656
|
+
},
|
|
1657
|
+
"/hosts/stats": {
|
|
1658
|
+
"get": {
|
|
1659
|
+
"parameters": [],
|
|
1660
|
+
"tags": [
|
|
1661
|
+
"default"
|
|
1662
|
+
],
|
|
1663
|
+
"operationId": "getHostStats",
|
|
1664
|
+
"summary": "Get Host Stats",
|
|
1665
|
+
"description": "hash of livestatus host statistics.",
|
|
1666
|
+
"responses": {
|
|
1667
|
+
"200": {
|
|
1668
|
+
"description": "successful operation"
|
|
1669
|
+
},
|
|
1670
|
+
"400": {
|
|
1671
|
+
"description": "failed operation"
|
|
1672
|
+
}
|
|
1673
|
+
}
|
|
1674
|
+
}
|
|
1675
|
+
},
|
|
1676
|
+
"/hosts/totals": {
|
|
1677
|
+
"get": {
|
|
1678
|
+
"parameters": [],
|
|
1679
|
+
"tags": [
|
|
1680
|
+
"default"
|
|
1681
|
+
],
|
|
1682
|
+
"operationId": "getHostTotals",
|
|
1683
|
+
"summary": "Get Host Totals",
|
|
1684
|
+
"description": "hash of livestatus host totals statistics. its basically a reduced set of /hosts/stats.",
|
|
1685
|
+
"responses": {
|
|
1686
|
+
"200": {
|
|
1687
|
+
"description": "successful operation"
|
|
1688
|
+
},
|
|
1689
|
+
"400": {
|
|
1690
|
+
"description": "failed operation"
|
|
1691
|
+
}
|
|
1692
|
+
}
|
|
1693
|
+
}
|
|
1694
|
+
},
|
|
1695
|
+
"/index": {
|
|
1696
|
+
"get": {
|
|
1697
|
+
"parameters": [],
|
|
1698
|
+
"tags": [
|
|
1699
|
+
"default"
|
|
1700
|
+
],
|
|
1701
|
+
"operationId": "getIndex",
|
|
1702
|
+
"summary": "Get Index",
|
|
1703
|
+
"description": "lists all available rest urls.",
|
|
1704
|
+
"responses": {
|
|
1705
|
+
"200": {
|
|
1706
|
+
"description": "successful operation"
|
|
1707
|
+
},
|
|
1708
|
+
"400": {
|
|
1709
|
+
"description": "failed operation"
|
|
1710
|
+
}
|
|
1711
|
+
}
|
|
1712
|
+
}
|
|
1713
|
+
},
|
|
1714
|
+
"/lmd/sites": {
|
|
1715
|
+
"get": {
|
|
1716
|
+
"parameters": [],
|
|
1717
|
+
"tags": [
|
|
1718
|
+
"default"
|
|
1719
|
+
],
|
|
1720
|
+
"operationId": "getLMDSites",
|
|
1721
|
+
"summary": "Get LMD Sites",
|
|
1722
|
+
"description": "lists connected sites. Only available if LMD (use_lmd) is enabled.",
|
|
1723
|
+
"responses": {
|
|
1724
|
+
"200": {
|
|
1725
|
+
"description": "successful operation"
|
|
1726
|
+
},
|
|
1727
|
+
"400": {
|
|
1728
|
+
"description": "failed operation"
|
|
1729
|
+
}
|
|
1730
|
+
}
|
|
1731
|
+
}
|
|
1732
|
+
},
|
|
1733
|
+
"/logs": {
|
|
1734
|
+
"get": {
|
|
1735
|
+
"parameters": [],
|
|
1736
|
+
"tags": [
|
|
1737
|
+
"default"
|
|
1738
|
+
],
|
|
1739
|
+
"operationId": "getLogs",
|
|
1740
|
+
"summary": "Get Logs",
|
|
1741
|
+
"description": "lists livestatus logs. see https://www.naemon.org/documentation/usersguide/livestatus.html#log for details.",
|
|
1742
|
+
"responses": {
|
|
1743
|
+
"200": {
|
|
1744
|
+
"description": "successful operation"
|
|
1745
|
+
},
|
|
1746
|
+
"400": {
|
|
1747
|
+
"description": "failed operation"
|
|
1748
|
+
}
|
|
1749
|
+
}
|
|
1750
|
+
}
|
|
1751
|
+
},
|
|
1752
|
+
"/notifications": {
|
|
1753
|
+
"get": {
|
|
1754
|
+
"parameters": [],
|
|
1755
|
+
"tags": [
|
|
1756
|
+
"default"
|
|
1757
|
+
],
|
|
1758
|
+
"operationId": "getNotifications",
|
|
1759
|
+
"summary": "Get Notifications",
|
|
1760
|
+
"description": "lists notifications based on logfiles. alias for /logs?class=3",
|
|
1761
|
+
"responses": {
|
|
1762
|
+
"200": {
|
|
1763
|
+
"description": "successful operation"
|
|
1764
|
+
},
|
|
1765
|
+
"400": {
|
|
1766
|
+
"description": "failed operation"
|
|
1767
|
+
}
|
|
1768
|
+
}
|
|
1769
|
+
}
|
|
1770
|
+
},
|
|
1771
|
+
"/processinfo": {
|
|
1772
|
+
"get": {
|
|
1773
|
+
"parameters": [],
|
|
1774
|
+
"tags": [
|
|
1775
|
+
"default"
|
|
1776
|
+
],
|
|
1777
|
+
"operationId": "getProcessInfo",
|
|
1778
|
+
"summary": "Get Process Info",
|
|
1779
|
+
"description": "lists livestatus sites status. see https://www.naemon.org/documentation/usersguide/livestatus.html#status for details.",
|
|
1780
|
+
"responses": {
|
|
1781
|
+
"200": {
|
|
1782
|
+
"description": "successful operation"
|
|
1783
|
+
},
|
|
1784
|
+
"400": {
|
|
1785
|
+
"description": "failed operation"
|
|
1786
|
+
}
|
|
1787
|
+
}
|
|
1788
|
+
}
|
|
1789
|
+
},
|
|
1790
|
+
"/ /processinfo/stats": {
|
|
1791
|
+
"get": {
|
|
1792
|
+
"parameters": [],
|
|
1793
|
+
"tags": [
|
|
1794
|
+
"default"
|
|
1795
|
+
],
|
|
1796
|
+
"operationId": "getProcessInfoStats",
|
|
1797
|
+
"summary": "Get Process Info Stats",
|
|
1798
|
+
"description": "lists livestatus sites statistics. see https://www.naemon.org/documentation/usersguide/livestatus.html#status for details.",
|
|
1799
|
+
"responses": {
|
|
1800
|
+
"200": {
|
|
1801
|
+
"description": "successful operation"
|
|
1802
|
+
},
|
|
1803
|
+
"400": {
|
|
1804
|
+
"description": "failed operation"
|
|
1805
|
+
}
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1808
|
+
},
|
|
1809
|
+
"/servicegroups": {
|
|
1810
|
+
"get": {
|
|
1811
|
+
"parameters": [],
|
|
1812
|
+
"tags": [
|
|
1813
|
+
"default"
|
|
1814
|
+
],
|
|
1815
|
+
"operationId": "getServiceGroups",
|
|
1816
|
+
"summary": "Get Service Groups",
|
|
1817
|
+
"description": "lists livestatus servicegroups. see https://www.naemon.org/documentation/usersguide/livestatus.html#servicegroups for details.",
|
|
1818
|
+
"responses": {
|
|
1819
|
+
"200": {
|
|
1820
|
+
"description": "successful operation"
|
|
1821
|
+
},
|
|
1822
|
+
"400": {
|
|
1823
|
+
"description": "failed operation"
|
|
1824
|
+
}
|
|
1825
|
+
}
|
|
1826
|
+
}
|
|
1827
|
+
},
|
|
1828
|
+
"/servicegroups/{name}": {
|
|
1829
|
+
"get": {
|
|
1830
|
+
"parameters": [
|
|
1831
|
+
{
|
|
1832
|
+
"name": "name",
|
|
1833
|
+
"in": "path",
|
|
1834
|
+
"description": "name",
|
|
1835
|
+
"required": true,
|
|
1836
|
+
"schema": {
|
|
1837
|
+
"type": "string"
|
|
1838
|
+
}
|
|
1839
|
+
}
|
|
1840
|
+
],
|
|
1841
|
+
"tags": [
|
|
1842
|
+
"default"
|
|
1843
|
+
],
|
|
1844
|
+
"operationId": "getServiceGroup",
|
|
1845
|
+
"summary": "Get Service Group",
|
|
1846
|
+
"description": "lists servicegroups for given name. alias for /servicegroups?name=<name>",
|
|
1847
|
+
"responses": {
|
|
1848
|
+
"200": {
|
|
1849
|
+
"description": "successful operation"
|
|
1850
|
+
},
|
|
1851
|
+
"400": {
|
|
1852
|
+
"description": "failed operation"
|
|
1853
|
+
}
|
|
1854
|
+
}
|
|
1855
|
+
}
|
|
1856
|
+
},
|
|
1857
|
+
"/servicegroups/{name}/config": {
|
|
1858
|
+
"get": {
|
|
1859
|
+
"parameters": [
|
|
1860
|
+
{
|
|
1861
|
+
"name": "name",
|
|
1862
|
+
"in": "path",
|
|
1863
|
+
"description": "name",
|
|
1864
|
+
"required": true,
|
|
1865
|
+
"schema": {
|
|
1866
|
+
"type": "string"
|
|
1867
|
+
}
|
|
1868
|
+
}
|
|
1869
|
+
],
|
|
1870
|
+
"tags": [
|
|
1871
|
+
"default"
|
|
1872
|
+
],
|
|
1873
|
+
"operationId": "getServiceGroupConfig",
|
|
1874
|
+
"summary": "Get Service Group Config",
|
|
1875
|
+
"description": "Returns configuration for given servicegroup. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#servicegroup",
|
|
1876
|
+
"responses": {
|
|
1877
|
+
"200": {
|
|
1878
|
+
"description": "successful operation"
|
|
1879
|
+
},
|
|
1880
|
+
"400": {
|
|
1881
|
+
"description": "failed operation"
|
|
1882
|
+
}
|
|
1883
|
+
}
|
|
1884
|
+
},
|
|
1885
|
+
"post": {
|
|
1886
|
+
"parameters": [
|
|
1887
|
+
{
|
|
1888
|
+
"name": "name",
|
|
1889
|
+
"in": "path",
|
|
1890
|
+
"description": "name",
|
|
1891
|
+
"required": true,
|
|
1892
|
+
"schema": {
|
|
1893
|
+
"type": "string"
|
|
1894
|
+
}
|
|
1895
|
+
}
|
|
1896
|
+
],
|
|
1897
|
+
"requestBody": {
|
|
1898
|
+
"description": "body",
|
|
1899
|
+
"required": true,
|
|
1900
|
+
"content": {
|
|
1901
|
+
"*/*": {
|
|
1902
|
+
"schema": {
|
|
1903
|
+
"type": "object"
|
|
1904
|
+
}
|
|
1905
|
+
}
|
|
1906
|
+
}
|
|
1907
|
+
},
|
|
1908
|
+
"tags": [
|
|
1909
|
+
"default"
|
|
1910
|
+
],
|
|
1911
|
+
"operationId": "postServiceGroupConfig",
|
|
1912
|
+
"summary": "Post Service Group Config",
|
|
1913
|
+
"description": "Replace servicegroup configuration completely, use PATCH to only update specific attributes.",
|
|
1914
|
+
"responses": {
|
|
1915
|
+
"200": {
|
|
1916
|
+
"description": "successful operation"
|
|
1917
|
+
},
|
|
1918
|
+
"400": {
|
|
1919
|
+
"description": "failed operation"
|
|
1920
|
+
}
|
|
1921
|
+
}
|
|
1922
|
+
},
|
|
1923
|
+
"patch": {
|
|
1924
|
+
"parameters": [
|
|
1925
|
+
{
|
|
1926
|
+
"name": "name",
|
|
1927
|
+
"in": "path",
|
|
1928
|
+
"description": "name",
|
|
1929
|
+
"required": true,
|
|
1930
|
+
"schema": {
|
|
1931
|
+
"type": "string"
|
|
1932
|
+
}
|
|
1933
|
+
}
|
|
1934
|
+
],
|
|
1935
|
+
"requestBody": {
|
|
1936
|
+
"description": "body",
|
|
1937
|
+
"required": true,
|
|
1938
|
+
"content": {
|
|
1939
|
+
"*/*": {
|
|
1940
|
+
"schema": {
|
|
1941
|
+
"type": "object"
|
|
1942
|
+
}
|
|
1943
|
+
}
|
|
1944
|
+
}
|
|
1945
|
+
},
|
|
1946
|
+
"tags": [
|
|
1947
|
+
"default"
|
|
1948
|
+
],
|
|
1949
|
+
"operationId": "patchServiceGroupConfig",
|
|
1950
|
+
"summary": "Patch Service Group Config",
|
|
1951
|
+
"description": "Update servicegroup configuration partially.",
|
|
1952
|
+
"responses": {
|
|
1953
|
+
"200": {
|
|
1954
|
+
"description": "successful operation"
|
|
1955
|
+
},
|
|
1956
|
+
"400": {
|
|
1957
|
+
"description": "failed operation"
|
|
1958
|
+
}
|
|
1959
|
+
}
|
|
1960
|
+
},
|
|
1961
|
+
"delete": {
|
|
1962
|
+
"parameters": [
|
|
1963
|
+
{
|
|
1964
|
+
"name": "name",
|
|
1965
|
+
"in": "path",
|
|
1966
|
+
"description": "name",
|
|
1967
|
+
"required": true,
|
|
1968
|
+
"schema": {
|
|
1969
|
+
"type": "string"
|
|
1970
|
+
}
|
|
1971
|
+
}
|
|
1972
|
+
],
|
|
1973
|
+
"tags": [
|
|
1974
|
+
"default"
|
|
1975
|
+
],
|
|
1976
|
+
"operationId": "deleteServiceGroupConfig",
|
|
1977
|
+
"summary": "Delete Service Group Config",
|
|
1978
|
+
"description": "Deletes given servicegroup from configuration.",
|
|
1979
|
+
"responses": {
|
|
1980
|
+
"200": {
|
|
1981
|
+
"description": "successful operation"
|
|
1982
|
+
},
|
|
1983
|
+
"400": {
|
|
1984
|
+
"description": "failed operation"
|
|
1985
|
+
}
|
|
1986
|
+
}
|
|
1987
|
+
}
|
|
1988
|
+
},
|
|
1989
|
+
"/servicegroups/{name}/outages": {
|
|
1990
|
+
"get": {
|
|
1991
|
+
"parameters": [
|
|
1992
|
+
{
|
|
1993
|
+
"name": "name",
|
|
1994
|
+
"in": "path",
|
|
1995
|
+
"description": "name",
|
|
1996
|
+
"required": true,
|
|
1997
|
+
"schema": {
|
|
1998
|
+
"type": "string"
|
|
1999
|
+
}
|
|
2000
|
+
}
|
|
2001
|
+
],
|
|
2002
|
+
"tags": [
|
|
2003
|
+
"default"
|
|
2004
|
+
],
|
|
2005
|
+
"operationId": "getServiceGroupOutages",
|
|
2006
|
+
"summary": "Get Service Group Outages",
|
|
2007
|
+
"description": "list of outages for this servicegroup.",
|
|
2008
|
+
"responses": {
|
|
2009
|
+
"200": {
|
|
2010
|
+
"description": "successful operation"
|
|
2011
|
+
},
|
|
2012
|
+
"400": {
|
|
2013
|
+
"description": "failed operation"
|
|
2014
|
+
}
|
|
2015
|
+
}
|
|
2016
|
+
}
|
|
2017
|
+
},
|
|
2018
|
+
"/servicegroups/{name}/stats": {
|
|
2019
|
+
"get": {
|
|
2020
|
+
"parameters": [
|
|
2021
|
+
{
|
|
2022
|
+
"name": "name",
|
|
2023
|
+
"in": "path",
|
|
2024
|
+
"description": "name",
|
|
2025
|
+
"required": true,
|
|
2026
|
+
"schema": {
|
|
2027
|
+
"type": "string"
|
|
2028
|
+
}
|
|
2029
|
+
}
|
|
2030
|
+
],
|
|
2031
|
+
"tags": [
|
|
2032
|
+
"default"
|
|
2033
|
+
],
|
|
2034
|
+
"operationId": "getServiceGroupStats",
|
|
2035
|
+
"summary": "Get Service Group Stats",
|
|
2036
|
+
"description": "hash of livestatus servicegroup statistics. alias for /services/stats?service_groups[gte]=<name>",
|
|
2037
|
+
"responses": {
|
|
2038
|
+
"200": {
|
|
2039
|
+
"description": "successful operation"
|
|
2040
|
+
},
|
|
2041
|
+
"400": {
|
|
2042
|
+
"description": "failed operation"
|
|
2043
|
+
}
|
|
2044
|
+
}
|
|
2045
|
+
}
|
|
2046
|
+
},
|
|
2047
|
+
"/services": {
|
|
2048
|
+
"get": {
|
|
2049
|
+
"parameters": [],
|
|
2050
|
+
"tags": [
|
|
2051
|
+
"default"
|
|
2052
|
+
],
|
|
2053
|
+
"operationId": "getServices",
|
|
2054
|
+
"summary": "Get Services",
|
|
2055
|
+
"description": "lists livestatus services. see https://www.naemon.org/documentation/usersguide/livestatus.html#services for details. there is an alias /services.",
|
|
2056
|
+
"responses": {
|
|
2057
|
+
"200": {
|
|
2058
|
+
"description": "successful operation"
|
|
2059
|
+
},
|
|
2060
|
+
"400": {
|
|
2061
|
+
"description": "failed operation"
|
|
2062
|
+
}
|
|
2063
|
+
}
|
|
2064
|
+
}
|
|
2065
|
+
},
|
|
2066
|
+
"/services/{host}/{service}": {
|
|
2067
|
+
"get": {
|
|
2068
|
+
"parameters": [
|
|
2069
|
+
{
|
|
2070
|
+
"name": "host",
|
|
2071
|
+
"in": "path",
|
|
2072
|
+
"description": "host",
|
|
2073
|
+
"required": true,
|
|
2074
|
+
"schema": {
|
|
2075
|
+
"type": "string"
|
|
2076
|
+
}
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"name": "service",
|
|
2080
|
+
"in": "path",
|
|
2081
|
+
"description": "service",
|
|
2082
|
+
"schema": {
|
|
2083
|
+
"type": "string"
|
|
2084
|
+
},
|
|
2085
|
+
"required": true
|
|
2086
|
+
}
|
|
2087
|
+
],
|
|
2088
|
+
"tags": [
|
|
2089
|
+
"default"
|
|
2090
|
+
],
|
|
2091
|
+
"operationId": "getHostService",
|
|
2092
|
+
"summary": "Get Host Service",
|
|
2093
|
+
"description": "lists services for given host and name. alias for /services?host_name=<host_name>&description=<service>",
|
|
2094
|
+
"responses": {
|
|
2095
|
+
"200": {
|
|
2096
|
+
"description": "successful operation"
|
|
2097
|
+
},
|
|
2098
|
+
"400": {
|
|
2099
|
+
"description": "failed operation"
|
|
2100
|
+
}
|
|
2101
|
+
}
|
|
2102
|
+
}
|
|
2103
|
+
},
|
|
2104
|
+
"/services/{host}/{service}/commandline": {
|
|
2105
|
+
"get": {
|
|
2106
|
+
"parameters": [
|
|
2107
|
+
{
|
|
2108
|
+
"name": "host",
|
|
2109
|
+
"in": "path",
|
|
2110
|
+
"description": "host",
|
|
2111
|
+
"required": true,
|
|
2112
|
+
"schema": {
|
|
2113
|
+
"type": "string"
|
|
2114
|
+
}
|
|
2115
|
+
},
|
|
2116
|
+
{
|
|
2117
|
+
"name": "service",
|
|
2118
|
+
"in": "path",
|
|
2119
|
+
"description": "service",
|
|
2120
|
+
"schema": {
|
|
2121
|
+
"type": "string"
|
|
2122
|
+
},
|
|
2123
|
+
"required": true
|
|
2124
|
+
}
|
|
2125
|
+
],
|
|
2126
|
+
"tags": [
|
|
2127
|
+
"default"
|
|
2128
|
+
],
|
|
2129
|
+
"operationId": "getHostServiceCommandLine",
|
|
2130
|
+
"summary": "Get Host Service Command Line",
|
|
2131
|
+
"description": "displays commandline for check command of given services.",
|
|
2132
|
+
"responses": {
|
|
2133
|
+
"200": {
|
|
2134
|
+
"description": "successful operation"
|
|
2135
|
+
},
|
|
2136
|
+
"400": {
|
|
2137
|
+
"description": "failed operation"
|
|
2138
|
+
}
|
|
2139
|
+
}
|
|
2140
|
+
}
|
|
2141
|
+
},
|
|
2142
|
+
"/services/{host}/{service}/config": {
|
|
2143
|
+
"get": {
|
|
2144
|
+
"parameters": [
|
|
2145
|
+
{
|
|
2146
|
+
"name": "host",
|
|
2147
|
+
"in": "path",
|
|
2148
|
+
"description": "host",
|
|
2149
|
+
"required": true,
|
|
2150
|
+
"schema": {
|
|
2151
|
+
"type": "string"
|
|
2152
|
+
}
|
|
2153
|
+
},
|
|
2154
|
+
{
|
|
2155
|
+
"name": "service",
|
|
2156
|
+
"in": "path",
|
|
2157
|
+
"description": "service",
|
|
2158
|
+
"required": true,
|
|
2159
|
+
"schema": {
|
|
2160
|
+
"type": "string"
|
|
2161
|
+
}
|
|
2162
|
+
}
|
|
2163
|
+
],
|
|
2164
|
+
"tags": [
|
|
2165
|
+
"default"
|
|
2166
|
+
],
|
|
2167
|
+
"operationId": "getHostServiceConfig",
|
|
2168
|
+
"summary": "Get Host Service Config",
|
|
2169
|
+
"description": "Returns configuration for given service. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#service",
|
|
2170
|
+
"responses": {
|
|
2171
|
+
"200": {
|
|
2172
|
+
"description": "successful operation"
|
|
2173
|
+
},
|
|
2174
|
+
"400": {
|
|
2175
|
+
"description": "failed operation"
|
|
2176
|
+
}
|
|
2177
|
+
}
|
|
2178
|
+
},
|
|
2179
|
+
"post": {
|
|
2180
|
+
"parameters": [
|
|
2181
|
+
{
|
|
2182
|
+
"name": "host",
|
|
2183
|
+
"in": "path",
|
|
2184
|
+
"description": "host",
|
|
2185
|
+
"schema": {
|
|
2186
|
+
"type": "string"
|
|
2187
|
+
},
|
|
2188
|
+
"required": true
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
"name": "service",
|
|
2192
|
+
"in": "path",
|
|
2193
|
+
"description": "service",
|
|
2194
|
+
"required": true,
|
|
2195
|
+
"schema": {
|
|
2196
|
+
"type": "string"
|
|
2197
|
+
}
|
|
2198
|
+
}
|
|
2199
|
+
],
|
|
2200
|
+
"requestBody": {
|
|
2201
|
+
"description": "body",
|
|
2202
|
+
"required": true,
|
|
2203
|
+
"content": {
|
|
2204
|
+
"*/*": {
|
|
2205
|
+
"schema": {
|
|
2206
|
+
"type": "object"
|
|
2207
|
+
}
|
|
2208
|
+
}
|
|
2209
|
+
}
|
|
2210
|
+
},
|
|
2211
|
+
"tags": [
|
|
2212
|
+
"default"
|
|
2213
|
+
],
|
|
2214
|
+
"operationId": "postHostServiceConfig",
|
|
2215
|
+
"summary": "Post Host Service Config",
|
|
2216
|
+
"description": "Replace service configuration completely, use PATCH to only update specific attributes.",
|
|
2217
|
+
"responses": {
|
|
2218
|
+
"200": {
|
|
2219
|
+
"description": "successful operation"
|
|
2220
|
+
},
|
|
2221
|
+
"400": {
|
|
2222
|
+
"description": "failed operation"
|
|
2223
|
+
}
|
|
2224
|
+
}
|
|
2225
|
+
},
|
|
2226
|
+
"patch": {
|
|
2227
|
+
"parameters": [
|
|
2228
|
+
{
|
|
2229
|
+
"name": "host",
|
|
2230
|
+
"in": "path",
|
|
2231
|
+
"description": "host",
|
|
2232
|
+
"required": true,
|
|
2233
|
+
"schema": {
|
|
2234
|
+
"type": "string"
|
|
2235
|
+
}
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"name": "service",
|
|
2239
|
+
"in": "path",
|
|
2240
|
+
"description": "service",
|
|
2241
|
+
"required": true,
|
|
2242
|
+
"schema": {
|
|
2243
|
+
"type": "string"
|
|
2244
|
+
}
|
|
2245
|
+
}
|
|
2246
|
+
],
|
|
2247
|
+
"requestBody": {
|
|
2248
|
+
"description": "body",
|
|
2249
|
+
"required": true,
|
|
2250
|
+
"content": {
|
|
2251
|
+
"*/*": {
|
|
2252
|
+
"schema": {
|
|
2253
|
+
"type": "object"
|
|
2254
|
+
}
|
|
2255
|
+
}
|
|
2256
|
+
}
|
|
2257
|
+
},
|
|
2258
|
+
"tags": [
|
|
2259
|
+
"default"
|
|
2260
|
+
],
|
|
2261
|
+
"operationId": "patchHostServiceConfig",
|
|
2262
|
+
"summary": "Patch Host Service Config",
|
|
2263
|
+
"description": "Update service configuration partially.",
|
|
2264
|
+
"responses": {
|
|
2265
|
+
"200": {
|
|
2266
|
+
"description": "successful operation"
|
|
2267
|
+
},
|
|
2268
|
+
"400": {
|
|
2269
|
+
"description": "failed operation"
|
|
2270
|
+
}
|
|
2271
|
+
}
|
|
2272
|
+
},
|
|
2273
|
+
"delete": {
|
|
2274
|
+
"parameters": [
|
|
2275
|
+
{
|
|
2276
|
+
"name": "host",
|
|
2277
|
+
"in": "path",
|
|
2278
|
+
"description": "host",
|
|
2279
|
+
"required": true,
|
|
2280
|
+
"schema": {
|
|
2281
|
+
"type": "string"
|
|
2282
|
+
}
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"name": "service",
|
|
2286
|
+
"in": "path",
|
|
2287
|
+
"description": "service",
|
|
2288
|
+
"schema": {
|
|
2289
|
+
"type": "string"
|
|
2290
|
+
},
|
|
2291
|
+
"required": true
|
|
2292
|
+
}
|
|
2293
|
+
],
|
|
2294
|
+
"tags": [
|
|
2295
|
+
"default"
|
|
2296
|
+
],
|
|
2297
|
+
"operationId": "deleteHostServiceConfig",
|
|
2298
|
+
"summary": "Delete Host Service Config",
|
|
2299
|
+
"description": "Deletes given service from configuration.",
|
|
2300
|
+
"responses": {
|
|
2301
|
+
"200": {
|
|
2302
|
+
"description": "successful operation"
|
|
2303
|
+
},
|
|
2304
|
+
"400": {
|
|
2305
|
+
"description": "failed operation"
|
|
2306
|
+
}
|
|
2307
|
+
}
|
|
2308
|
+
}
|
|
2309
|
+
},
|
|
2310
|
+
"/services/{host}/{service}/outages": {
|
|
2311
|
+
"get": {
|
|
2312
|
+
"parameters": [
|
|
2313
|
+
{
|
|
2314
|
+
"name": "host",
|
|
2315
|
+
"in": "path",
|
|
2316
|
+
"description": "host",
|
|
2317
|
+
"schema": {
|
|
2318
|
+
"type": "string"
|
|
2319
|
+
},
|
|
2320
|
+
"required": true
|
|
2321
|
+
},
|
|
2322
|
+
{
|
|
2323
|
+
"name": "service",
|
|
2324
|
+
"in": "path",
|
|
2325
|
+
"description": "service",
|
|
2326
|
+
"schema": {
|
|
2327
|
+
"type": "string"
|
|
2328
|
+
},
|
|
2329
|
+
"required": true
|
|
2330
|
+
}
|
|
2331
|
+
],
|
|
2332
|
+
"tags": [
|
|
2333
|
+
"default"
|
|
2334
|
+
],
|
|
2335
|
+
"operationId": "getHostServiceOutages",
|
|
2336
|
+
"summary": "Get Host Service Outages",
|
|
2337
|
+
"description": "list of outages for this service.",
|
|
2338
|
+
"responses": {
|
|
2339
|
+
"200": {
|
|
2340
|
+
"description": "successful operation"
|
|
2341
|
+
},
|
|
2342
|
+
"400": {
|
|
2343
|
+
"description": "failed operation"
|
|
2344
|
+
}
|
|
2345
|
+
}
|
|
2346
|
+
}
|
|
2347
|
+
},
|
|
2348
|
+
"/services/outages": {
|
|
2349
|
+
"get": {
|
|
2350
|
+
"parameters": [],
|
|
2351
|
+
"tags": [
|
|
2352
|
+
"default"
|
|
2353
|
+
],
|
|
2354
|
+
"operationId": "getServicesOutages",
|
|
2355
|
+
"summary": "Get Services Outages",
|
|
2356
|
+
"description": "list of outages for all services.",
|
|
2357
|
+
"responses": {
|
|
2358
|
+
"200": {
|
|
2359
|
+
"description": "successful operation"
|
|
2360
|
+
},
|
|
2361
|
+
"400": {
|
|
2362
|
+
"description": "failed operation"
|
|
2363
|
+
}
|
|
2364
|
+
}
|
|
2365
|
+
}
|
|
2366
|
+
},
|
|
2367
|
+
"/services/stats": {
|
|
2368
|
+
"get": {
|
|
2369
|
+
"parameters": [],
|
|
2370
|
+
"tags": [
|
|
2371
|
+
"default"
|
|
2372
|
+
],
|
|
2373
|
+
"operationId": "getServicesStats",
|
|
2374
|
+
"summary": "Get Services Stats",
|
|
2375
|
+
"description": "livestatus service statistics",
|
|
2376
|
+
"responses": {
|
|
2377
|
+
"200": {
|
|
2378
|
+
"description": "successful operation"
|
|
2379
|
+
},
|
|
2380
|
+
"400": {
|
|
2381
|
+
"description": "failed operation"
|
|
2382
|
+
}
|
|
2383
|
+
}
|
|
2384
|
+
}
|
|
2385
|
+
},
|
|
2386
|
+
"/services/totals": {
|
|
2387
|
+
"get": {
|
|
2388
|
+
"parameters": [],
|
|
2389
|
+
"tags": [
|
|
2390
|
+
"default"
|
|
2391
|
+
],
|
|
2392
|
+
"operationId": "getServicesTotals",
|
|
2393
|
+
"summary": "Get Services Totals",
|
|
2394
|
+
"description": "livestatus service totals statistics. its basically a reduced set of /services/stats.",
|
|
2395
|
+
"responses": {
|
|
2396
|
+
"200": {
|
|
2397
|
+
"description": "successful operation"
|
|
2398
|
+
},
|
|
2399
|
+
"400": {
|
|
2400
|
+
"description": "failed operation"
|
|
2401
|
+
}
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
},
|
|
2405
|
+
"/sites": {
|
|
2406
|
+
"get": {
|
|
2407
|
+
"parameters": [],
|
|
2408
|
+
"tags": [
|
|
2409
|
+
"default"
|
|
2410
|
+
],
|
|
2411
|
+
"operationId": "getSites",
|
|
2412
|
+
"summary": "Get Sites",
|
|
2413
|
+
"description": "lists configured backends",
|
|
2414
|
+
"responses": {
|
|
2415
|
+
"200": {
|
|
2416
|
+
"description": "successful operation"
|
|
2417
|
+
},
|
|
2418
|
+
"400": {
|
|
2419
|
+
"description": "failed operation"
|
|
2420
|
+
}
|
|
2421
|
+
}
|
|
2422
|
+
}
|
|
2423
|
+
},
|
|
2424
|
+
"/thruk": {
|
|
2425
|
+
"get": {
|
|
2426
|
+
"parameters": [],
|
|
2427
|
+
"tags": [
|
|
2428
|
+
"default"
|
|
2429
|
+
],
|
|
2430
|
+
"operationId": "getThruk",
|
|
2431
|
+
"summary": "getThruk",
|
|
2432
|
+
"description": "hash of basic information about this thruk instance",
|
|
2433
|
+
"responses": {
|
|
2434
|
+
"200": {
|
|
2435
|
+
"description": "successful operation"
|
|
2436
|
+
},
|
|
2437
|
+
"400": {
|
|
2438
|
+
"description": "failed operation"
|
|
2439
|
+
}
|
|
2440
|
+
}
|
|
2441
|
+
}
|
|
2442
|
+
},
|
|
2443
|
+
"/thruk/whoami": {
|
|
2444
|
+
"get": {
|
|
2445
|
+
"parameters": [],
|
|
2446
|
+
"tags": [
|
|
2447
|
+
"default"
|
|
2448
|
+
],
|
|
2449
|
+
"operationId": "getThrukWhoami",
|
|
2450
|
+
"summary": "Get Thruk whoami",
|
|
2451
|
+
"description": "show current profile information. alias for /thruk/users?id=<id>",
|
|
2452
|
+
"responses": {
|
|
2453
|
+
"200": {
|
|
2454
|
+
"description": "successful operation"
|
|
2455
|
+
},
|
|
2456
|
+
"400": {
|
|
2457
|
+
"description": "failed operation"
|
|
2458
|
+
}
|
|
2459
|
+
}
|
|
2460
|
+
}
|
|
2461
|
+
},
|
|
2462
|
+
"/timeperiods": {
|
|
2463
|
+
"get": {
|
|
2464
|
+
"parameters": [],
|
|
2465
|
+
"tags": [
|
|
2466
|
+
"default"
|
|
2467
|
+
],
|
|
2468
|
+
"operationId": "getTimePeriods",
|
|
2469
|
+
"summary": "Get Time Periods",
|
|
2470
|
+
"description": "lists livestatus timeperiods. see https://www.naemon.org/documentation/usersguide/livestatus.html#timeperiods for details.",
|
|
2471
|
+
"responses": {
|
|
2472
|
+
"200": {
|
|
2473
|
+
"description": "successful operation"
|
|
2474
|
+
},
|
|
2475
|
+
"400": {
|
|
2476
|
+
"description": "failed operation"
|
|
2477
|
+
}
|
|
2478
|
+
}
|
|
2479
|
+
}
|
|
2480
|
+
},
|
|
2481
|
+
"/timeperiods/{name}": {
|
|
2482
|
+
"get": {
|
|
2483
|
+
"parameters": [
|
|
2484
|
+
{
|
|
2485
|
+
"name": "name",
|
|
2486
|
+
"in": "path",
|
|
2487
|
+
"description": "name",
|
|
2488
|
+
"required": true,
|
|
2489
|
+
"schema": {
|
|
2490
|
+
"type": "string"
|
|
2491
|
+
}
|
|
2492
|
+
}
|
|
2493
|
+
],
|
|
2494
|
+
"tags": [
|
|
2495
|
+
"default"
|
|
2496
|
+
],
|
|
2497
|
+
"operationId": "getTimePeriod",
|
|
2498
|
+
"summary": "Get Time Period",
|
|
2499
|
+
"description": "lists timeperiods for given name. alias for /timeperiods?name=<name>",
|
|
2500
|
+
"responses": {
|
|
2501
|
+
"200": {
|
|
2502
|
+
"description": "successful operation"
|
|
2503
|
+
},
|
|
2504
|
+
"400": {
|
|
2505
|
+
"description": "failed operation"
|
|
2506
|
+
}
|
|
2507
|
+
}
|
|
2508
|
+
}
|
|
2509
|
+
},
|
|
2510
|
+
"/timeperiods/{name}/config": {
|
|
2511
|
+
"get": {
|
|
2512
|
+
"parameters": [
|
|
2513
|
+
{
|
|
2514
|
+
"name": "name",
|
|
2515
|
+
"in": "path",
|
|
2516
|
+
"description": "name",
|
|
2517
|
+
"required": true,
|
|
2518
|
+
"schema": {
|
|
2519
|
+
"type": "string"
|
|
2520
|
+
}
|
|
2521
|
+
}
|
|
2522
|
+
],
|
|
2523
|
+
"tags": [
|
|
2524
|
+
"default"
|
|
2525
|
+
],
|
|
2526
|
+
"operationId": "getTimePeriodConfig",
|
|
2527
|
+
"summary": "Get Time Period Config",
|
|
2528
|
+
"description": "Returns configuration for given timeperiod. You will find available attributes here: http://www.naemon.org/documentation/usersguide/objectdefinitions.html#timeperiod",
|
|
2529
|
+
"responses": {
|
|
2530
|
+
"200": {
|
|
2531
|
+
"description": "successful operation"
|
|
2532
|
+
},
|
|
2533
|
+
"400": {
|
|
2534
|
+
"description": "failed operation"
|
|
2535
|
+
}
|
|
2536
|
+
}
|
|
2537
|
+
},
|
|
2538
|
+
"post": {
|
|
2539
|
+
"parameters": [
|
|
2540
|
+
{
|
|
2541
|
+
"name": "name",
|
|
2542
|
+
"in": "path",
|
|
2543
|
+
"description": "name",
|
|
2544
|
+
"schema": {
|
|
2545
|
+
"type": "string"
|
|
2546
|
+
},
|
|
2547
|
+
"required": true
|
|
2548
|
+
}
|
|
2549
|
+
],
|
|
2550
|
+
"requestBody": {
|
|
2551
|
+
"description": "body",
|
|
2552
|
+
"required": true,
|
|
2553
|
+
"content": {
|
|
2554
|
+
"*/*": {
|
|
2555
|
+
"schema": {
|
|
2556
|
+
"type": "object"
|
|
2557
|
+
}
|
|
2558
|
+
}
|
|
2559
|
+
}
|
|
2560
|
+
},
|
|
2561
|
+
"tags": [
|
|
2562
|
+
"default"
|
|
2563
|
+
],
|
|
2564
|
+
"operationId": "postTimePeriodConfig",
|
|
2565
|
+
"summary": "Post Time Period Config",
|
|
2566
|
+
"description": "Replace timeperiod configuration completely, use PATCH to only update specific attributes.",
|
|
2567
|
+
"responses": {
|
|
2568
|
+
"200": {
|
|
2569
|
+
"description": "successful operation"
|
|
2570
|
+
},
|
|
2571
|
+
"400": {
|
|
2572
|
+
"description": "failed operation"
|
|
2573
|
+
}
|
|
2574
|
+
}
|
|
2575
|
+
},
|
|
2576
|
+
"patch": {
|
|
2577
|
+
"parameters": [
|
|
2578
|
+
{
|
|
2579
|
+
"name": "name",
|
|
2580
|
+
"in": "path",
|
|
2581
|
+
"description": "name",
|
|
2582
|
+
"required": true,
|
|
2583
|
+
"schema": {
|
|
2584
|
+
"type": "string"
|
|
2585
|
+
}
|
|
2586
|
+
}
|
|
2587
|
+
],
|
|
2588
|
+
"requestBody": {
|
|
2589
|
+
"description": "body",
|
|
2590
|
+
"required": true,
|
|
2591
|
+
"content": {
|
|
2592
|
+
"*/*": {
|
|
2593
|
+
"schema": {
|
|
2594
|
+
"type": "object"
|
|
2595
|
+
}
|
|
2596
|
+
}
|
|
2597
|
+
}
|
|
2598
|
+
},
|
|
2599
|
+
"tags": [
|
|
2600
|
+
"default"
|
|
2601
|
+
],
|
|
2602
|
+
"operationId": "patchTimePeriodConfig",
|
|
2603
|
+
"summary": "Patch Time Period Config",
|
|
2604
|
+
"description": "Update timeperiods configuration partially.",
|
|
2605
|
+
"responses": {
|
|
2606
|
+
"200": {
|
|
2607
|
+
"description": "successful operation"
|
|
2608
|
+
},
|
|
2609
|
+
"400": {
|
|
2610
|
+
"description": "failed operation"
|
|
2611
|
+
}
|
|
2612
|
+
}
|
|
2613
|
+
},
|
|
2614
|
+
"delete": {
|
|
2615
|
+
"parameters": [
|
|
2616
|
+
{
|
|
2617
|
+
"name": "name",
|
|
2618
|
+
"in": "path",
|
|
2619
|
+
"description": "name",
|
|
2620
|
+
"required": true,
|
|
2621
|
+
"schema": {
|
|
2622
|
+
"type": "string"
|
|
2623
|
+
}
|
|
2624
|
+
}
|
|
2625
|
+
],
|
|
2626
|
+
"tags": [
|
|
2627
|
+
"default"
|
|
2628
|
+
],
|
|
2629
|
+
"operationId": "deleteTimePeriodConfig",
|
|
2630
|
+
"summary": "Delete Time Period Config",
|
|
2631
|
+
"description": "Deletes given timeperiod from configuration.",
|
|
2632
|
+
"responses": {
|
|
2633
|
+
"200": {
|
|
2634
|
+
"description": "successful operation"
|
|
2635
|
+
},
|
|
2636
|
+
"400": {
|
|
2637
|
+
"description": "failed operation"
|
|
2638
|
+
}
|
|
2639
|
+
}
|
|
2640
|
+
}
|
|
2641
|
+
}
|
|
2642
|
+
},
|
|
2643
|
+
"externalDocs": {
|
|
2644
|
+
"description": "Find out more about the OpenAPI Initiative",
|
|
2645
|
+
"url": "https://www.openapis.org/"
|
|
2646
|
+
},
|
|
2647
|
+
"tags": [
|
|
2648
|
+
{
|
|
2649
|
+
"name": "default",
|
|
2650
|
+
"description": ""
|
|
2651
|
+
}
|
|
2652
|
+
],
|
|
2653
|
+
"components": {
|
|
2654
|
+
"securitySchemes": {}
|
|
2655
|
+
}
|
|
2656
|
+
}
|