-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
3798 lines (3798 loc) · 102 KB
/
openapi.yaml
File metadata and controls
3798 lines (3798 loc) · 102 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Notifier
description: Internal alerting service for Watchdog
version: 0.0.5
paths:
/internal/v1/api/alertmanager/alerts:
get:
tags:
- alertmanager
summary: List Alerts
description: Lists alertmanager alerts with optional state and label filtering
for the current user scope.
operationId: list_alerts
security:
- HTTPBearer: []
parameters:
- name: active
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Active
- name: silenced
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Silenced
- name: inhibited
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Inhibited
- name: filter_labels
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter Labels
- name: show_hidden
in: query
required: false
schema:
type: boolean
default: false
title: Show Hidden
responses:
'200':
description: The alerts visible to the current caller.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Alert-Output'
title: Response List Alerts
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- alertmanager
summary: Create Alerts
description: Submits one or more alerts to alertmanager for processing.
operationId: create_alerts
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Alert-Input'
title: Alerts
responses:
'200':
description: The submission result including the number of alerts accepted.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Create Alerts
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- alertmanager
summary: Delete Alerts
description: Deletes alerts in alertmanager that match the provided label filter
set.
operationId: delete_alerts
security:
- HTTPBearer: []
parameters:
- name: filter_labels
in: query
required: true
schema:
type: string
title: Filter Labels
responses:
'200':
description: The deletion result for the matched alerts.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Delete Alerts
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/alerts/groups:
get:
tags:
- alertmanager
summary: List Alert Groups
description: Lists grouped alerts from alertmanager with optional label filtering.
operationId: list_alert_groups
security:
- HTTPBearer: []
parameters:
- name: filter_labels
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter Labels
responses:
'200':
description: Grouped alerts returned by alertmanager.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AlertGroup'
title: Response List Alert Groups
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/access/group-shares/prune:
post:
tags:
- alertmanager
summary: Prune Group Shares
description: Removes stale shared-group visibility references for users that
were removed from a group.
operationId: prune_group_shares
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupSharePruneRequest'
required: true
responses:
'200':
description: The counts of updated records and pruned silences.
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Prune Group Shares
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/integrations/channel-types:
get:
tags:
- alertmanager
summary: List Allowed Channel Types
description: Lists notification channel types that are currently enabled for
alertmanager integrations.
operationId: list_channel_types
responses:
'200':
description: The channel types allowed by integration policy.
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response List Channel Types
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
security:
- HTTPBearer: []
/internal/v1/api/alertmanager/silences:
get:
tags:
- alertmanager-silences
summary: List Silences
description: Lists silences visible to the current user with optional label
and expiration filtering.
operationId: list_silences
security:
- HTTPBearer: []
parameters:
- name: filter_labels
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter Labels
- name: include_expired
in: query
required: false
schema:
type: boolean
default: false
title: Include Expired
- name: show_hidden
in: query
required: false
schema:
type: string
pattern: ^(true|false)$
default: 'false'
title: Show Hidden
responses:
'200':
description: The silences visible to the current caller.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Silence'
title: Response List Silences
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- alertmanager-silences
summary: Create Silence
description: Creates a new silence in alertmanager for the current user scope.
operationId: create_silence
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SilenceCreateRequest'
responses:
'200':
description: The created silence identifier and operation result.
content:
application/json:
schema:
type: object
additionalProperties:
type: string
title: Response Create Silence
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/silences/{silence_id}:
get:
tags:
- alertmanager-silences
summary: Get Silence
description: Returns a single silence when it exists and is visible to the current
user.
operationId: get_silence
security:
- HTTPBearer: []
parameters:
- name: silence_id
in: path
required: true
schema:
type: string
title: Silence Id
- name: show_hidden
in: query
required: false
schema:
type: string
pattern: ^(true|false)$
default: 'false'
title: Show Hidden
responses:
'200':
description: The requested silence.
content:
application/json:
schema:
$ref: '#/components/schemas/Silence'
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- alertmanager-silences
summary: Update Silence
description: Updates an existing silence when the caller owns it and still has
access.
operationId: update_silence
security:
- HTTPBearer: []
parameters:
- name: silence_id
in: path
required: true
schema:
type: string
title: Silence Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SilenceCreateRequest'
responses:
'200':
description: The updated silence identifier and operation result.
content:
application/json:
schema:
type: object
additionalProperties:
type: string
title: Response Update Silence
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- alertmanager-silences
summary: Delete Silence
description: Deletes an existing silence when the caller owns it and still has
access.
operationId: delete_silence
security:
- HTTPBearer: []
parameters:
- name: silence_id
in: path
required: true
schema:
type: string
title: Silence Id
responses:
'200':
description: The deletion result for the specified silence.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Delete Silence
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/silences/{silence_id}/hide:
post:
tags:
- alertmanager-silences
summary: Hide Silence
description: Toggles whether a shared silence is hidden for the current user.
operationId: hide_silence
security:
- HTTPBearer: []
parameters:
- name: silence_id
in: path
required: true
schema:
type: string
title: Silence Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/routers__observability__alerts__shared__HideTogglePayload'
responses:
'200':
description: The hide state applied to the silence.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Hide Silence
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/status:
get:
tags:
- alertmanager
summary: Get Alertmanager Status
description: Returns alertmanager runtime status and cluster metadata.
operationId: get_alertmanager_status
responses:
'200':
description: The current alertmanager status payload.
content:
application/json:
schema:
$ref: '#/components/schemas/AlertManagerStatus'
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
security:
- HTTPBearer: []
/internal/v1/api/alertmanager/receivers:
get:
tags:
- alertmanager
summary: List Receivers
description: Lists alertmanager receiver names available for routing and inspection.
operationId: list_receivers
responses:
'200':
description: The configured alertmanager receiver names.
content:
application/json:
schema:
items:
type: string
type: array
title: Response List Receivers
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
security:
- HTTPBearer: []
/internal/v1/api/alertmanager/rules/import:
post:
tags:
- alertmanager-rules
summary: Import Alert Rules
description: Imports alert rules from YAML, optionally previewing the parsed
rules without persisting them.
operationId: import_rules
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RuleImportRequest'
required: true
responses:
'200':
description: The imported or previewed rule set with creation and update
counts.
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Import Rules
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/internal/v1/api/alertmanager/rules:
get:
tags:
- alertmanager-rules
summary: List Alert Rules
description: Lists alert rules visible to the current user with pagination support.
operationId: list_rules
security:
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1000
minimum: 1
default: 20
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: show_hidden
in: query
required: false
schema:
type: string
pattern: ^(true|false)$
default: 'false'
title: Show Hidden
responses:
'200':
description: The alert rules visible to the current caller.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AlertRule'
title: Response List Rules
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- alertmanager-rules
summary: Create Alert Rule
description: Creates a new alert rule and synchronizes it to the backing Mimir
rule set.
operationId: create_rule
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRuleCreate'
responses:
'201':
description: The newly created alert rule.
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRule'
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/public/rules:
get:
tags:
- alertmanager-rules
summary: List Public Alert Rules
description: Lists public alert rules for the default tenant after public endpoint
protections are enforced.
operationId: list_public_rules
responses:
'200':
description: The public alert rules available for the default tenant.
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AlertRule'
type: array
title: Response List Public Rules
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
/internal/v1/api/alertmanager/metrics/names:
get:
tags:
- alertmanager-rules
summary: List Metric Names
description: Lists metric names available in Mimir for the resolved organization
scope.
operationId: list_metric_names
security:
- HTTPBearer: []
parameters:
- name: orgId
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Orgid
responses:
'200':
description: The resolved organization identifier and metric names.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Metric Names
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/metrics/query:
get:
tags:
- alertmanager-rules
summary: Evaluate PromQL Query
description: Evaluates a PromQL query against Mimir for the resolved organization
scope.
operationId: query_metrics
security:
- HTTPBearer: []
parameters:
- name: query
in: query
required: true
schema:
type: string
minLength: 1
title: Query
- name: orgId
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Orgid
- name: sampleLimit
in: query
required: false
schema:
type: integer
maximum: 20
minimum: 1
default: 5
title: Samplelimit
responses:
'200':
description: The evaluated query result returned from Mimir.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Query Metrics
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/metrics/labels:
get:
tags:
- alertmanager-rules
summary: List Metric Labels
description: Lists label names available in Mimir for the resolved organization
scope.
operationId: list_metric_labels
security:
- HTTPBearer: []
parameters:
- name: orgId
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Orgid
responses:
'200':
description: The resolved organization identifier and metric label names.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Metric Labels
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/internal/v1/api/alertmanager/metrics/label-values/{label}:
get:
tags:
- alertmanager-rules
summary: List Metric Label Values
description: Lists values for a metric label in Mimir for the resolved organization
scope.
operationId: list_metric_label_values
security:
- HTTPBearer: []
parameters:
- name: label
in: path
required: true
schema:
type: string
title: Label
- name: orgId
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Orgid
- name: metricName
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Metricname
responses:
'200':
description: The resolved organization identifier and metric label values.
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response List Metric Label Values
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'400':
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'404':
description: Not Found
/internal/v1/api/alertmanager/rules/{rule_id}:
get:
tags:
- alertmanager-rules
summary: Get Alert Rule
description: Returns a single alert rule when it exists and is visible to the
current user.
operationId: get_rule
security:
- HTTPBearer: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
title: Rule Id
responses:
'200':
description: The requested alert rule.
content:
application/json:
schema:
$ref: '#/components/schemas/AlertRule'
'401':
description: Unauthorized
'403':
description: Forbidden
'429':
description: Too Many Requests
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- alertmanager-rules
summary: Update Alert Rule
description: Updates an existing alert rule and synchronizes affected Mimir
rule sets.
operationId: update_rule
security:
- HTTPBearer: []
parameters:
- name: rule_id