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