-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
7526 lines (7404 loc) · 209 KB
/
openapi.yaml
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.0.0
info:
title: ilert REST API
description: >-
The ilert API is a
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API
and provides programmatic access to entities in ilert and lets you easily
integrate ilert with 3rd party tools. If you are looking to develop an
inbound integration (e.g. for a monitoring tool), please use our [Events
API](https://api.ilert.com).
The API supports the JSON content type for requests and responses. The
response content type is requested via the HTTP Accept header
(`application/json`). All resources are accessible via https and are located
at `api.ilert.com/api`.
## Authentication
The REST API accepts bearer API tokens. Each user may create API keys using
the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g.
`Bearer APIKEY` when sending api key requests. By default, access to all
resources (using any method) requires the client to be authenticated.
## Team Context
When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team.
## Errors
ilert uses HTTP response codes to indicate success or failure of an API
request. Codes in the 2xx range indicate success, codes in the 4xx range
indicate a client error (e.g. a missing required parameter) and codes in the
5xx range indicate an error with ilert's servers. In case of an error, the
response body contains the following information:
Attribute | Description
------------- | -------------
status | the corresponsing HTTP status code
message | a human readable description of the error
code | error code, used to identify error type
## API Versioning
Changes to our API are always backwards-compatible. To get more information
about our API versioning and historical changes, please <a
href='https://docs.ilert.com/rest-api/api-version-history'
target='_blank'>take a look here</a>.
version: ''
x-logo:
url: ./ilert-logo-spaced.png
backgroundColor: '#fafafa'
altText: ilert documentation logo
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: /api
tags:
- name: Notification Preferences
- name: Status Pages
- name: Alerts
- name: Contacts
- name: Schedules
- name: Users
- name: Alert Actions
- name: Teams
- name: Services
- name: Incidents
- name: Service Outages
- name: Escalation Policies
- name: Alert Sources
- name: Support Hours
- name: Connectors
- name: Maintenance Windows
- name: Incident Templates
- name: Automation Rules
- name: Metrics
- name: Metric Data Sources
- name: Heartbeats
- name: Reports
- name: Numbers
- name: Integrations
- name: Events
- name: Series
- name: Log-Entries
- name: Notifications
- name: On-Calls
paths:
/users/{user-id}:
get:
tags:
- Users
summary: Get the specified user.
operationId: Users_getUserById
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: the user object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
put:
tags:
- Users
summary: Update an existing user.
operationId: Users_updateExistingUser
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
description: the user object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: the updated user
content:
application/json:
schema:
$ref: '#/components/schemas/User'
delete:
tags:
- Users
summary: Delete the specified user.
operationId: Users_deleteUser
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'204':
description: if deletion was successful
/users/{user-id}/contacts/emails:
get:
tags:
- Contacts
summary: Get a user's emails
operationId: Contacts_getUserEmails
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactsGetUserEmailsResponse'
post:
tags:
- Contacts
summary: Create a new email
operationId: Contacts_addNewEmail
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEmailPost'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEmail'
/users/{user-id}/contacts/emails/{id}:
get:
tags:
- Contacts
summary: Get a specific email
operationId: Contacts_getEmail
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEmail'
put:
tags:
- Contacts
summary: Update a user's email
operationId: Contacts_updateUserEmail
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEmailPost'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactEmail'
delete:
tags:
- Contacts
summary: Delete the user's specified email
operationId: Contacts_deleteUserEmail
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'204':
description: if deletion was successful
/users/{user-id}/contacts/phone-numbers:
get:
tags:
- Contacts
summary: Get a user's phone numbers
operationId: Contacts_getUserPhoneNumbers
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactsGetUserPhoneNumbersResponse'
post:
tags:
- Contacts
summary: Create a phone number
operationId: Contacts_createPhoneNumber
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPhoneNumberPost'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPhoneNumber'
/users/{user-id}/contacts/phone-numbers/{id}:
get:
tags:
- Contacts
summary: Get specific phone number
operationId: Contacts_getPhoneNumber
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPhoneNumber'
put:
tags:
- Contacts
summary: Update a user's phone number
operationId: Contacts_updateUserPhoneNumber
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPhoneNumberPost'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPhoneNumber'
delete:
tags:
- Contacts
summary: Delete the user's specified phone number
operationId: Contacts_deletePhoneNumber
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'204':
description: if deletion was successful
/users/{user-id}/notification-preferences/alerts:
get:
tags:
- Notification Preferences
summary: Get alert notification preferences of a user
operationId: NotificationPreferences_getUserAlerts
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/NotificationPreferencesGetUserAlertsResponse
post:
tags:
- Notification Preferences
summary: Create an alert notification preference
operationId: NotificationPreferences_createAlertPreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesAlertPost'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesAlert'
/users/{user-id}/notification-preferences/alerts/{id}:
get:
tags:
- Notification Preferences
summary: Get specific notification preferences alert
operationId: NotificationPreferences_getSpecificAlert
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesAlert'
put:
tags:
- Notification Preferences
summary: Update a user's alert notification preference
operationId: NotificationPreferences_updateAlertPreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesAlertPost'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesAlert'
delete:
tags:
- Notification Preferences
summary: Delete the user's specified notification preferences alert
operationId: NotificationPreferences_deleteUserNotificationPreferencesAlert
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'204':
description: if deletion was successful
/users/{user-id}/notification-preferences/duties:
get:
tags:
- Notification Preferences
summary: Get duty notification preferences of a user
operationId: NotificationPreferences_getUserDutyPreferences
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/NotificationPreferencesGetUserDutyPreferencesResponse
post:
tags:
- Notification Preferences
summary: Create a duty notification preference
operationId: NotificationPreferences_createDuty
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesDutyPost'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesDuty'
/users/{user-id}/notification-preferences/duties/{id}:
get:
tags:
- Notification Preferences
summary: Get specific notification preferences duty
operationId: NotificationPreferences_getSpecificDuty
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesDuty'
put:
tags:
- Notification Preferences
summary: Update a user's duty notification preference
operationId: NotificationPreferences_updateDutyNotificationPreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesDutyPost'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesDuty'
delete:
tags:
- Notification Preferences
summary: Delete the user's specified notification preferences duty
operationId: NotificationPreferences_deleteUserNotificationDuty
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'204':
description: if deletion was successful
/users/{user-id}/notification-preferences/updates:
get:
tags:
- Notification Preferences
summary: Get update notification preferences of a user
operationId: NotificationPreferences_getUserUpdatePreferences
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/NotificationPreferencesGetUserUpdatePreferencesResponse
post:
tags:
- Notification Preferences
summary: Create an update notification preference
operationId: NotificationPreferences_createUpdatePreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesUpdatePost'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesUpdate'
/users/{user-id}/notification-preferences/updates/{id}:
get:
tags:
- Notification Preferences
summary: Get specific notification preferences update
operationId: NotificationPreferences_getSpecificUpdate
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesUpdate'
put:
tags:
- Notification Preferences
summary: Update a user's update notification preference
operationId: NotificationPreferences_updateUserUpdateNotificationPreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesUpdatePost'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesUpdate'
delete:
tags:
- Notification Preferences
summary: Delete the user's specified notification preferences update
operationId: NotificationPreferences_deleteUpdate
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'204':
description: if deletion was successful
/users/{user-id}/notification-preferences/subscriptions:
get:
tags:
- Notification Preferences
summary: Get subscription notification preferences of a user
operationId: NotificationPreferences_getUserSubscriptions
parameters:
- $ref: '#/components/parameters/user-id-in-path'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/NotificationPreferencesGetUserSubscriptionsResponse
post:
tags:
- Notification Preferences
summary: Create a subscription notification preference
operationId: NotificationPreferences_createSubscriptionNotificationPreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesSubscriptionPost'
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesSubscription'
/users/{user-id}/notification-preferences/subscriptions/{id}:
get:
tags:
- Notification Preferences
summary: Get specific notification preferences subscription
operationId: NotificationPreferences_getSpecificSubscription
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesSubscription'
put:
tags:
- Notification Preferences
summary: Update a user's subscription notification preference
operationId: NotificationPreferences_updateSubscriptionPreference
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesSubscriptionPost'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesSubscription'
delete:
tags:
- Notification Preferences
summary: Delete the user's specified notification preferences subscription
operationId: NotificationPreferences_deleteSubscription
parameters:
- $ref: '#/components/parameters/user-id-in-path'
- $ref: '#/components/parameters/id'
responses:
'204':
description: if deletion was successful
/numbers:
get:
tags:
- Numbers
summary: >-
List available phone numbers that ilert uses to send voice and SMS
notifications
operationId: Numbers_listAvailableNumbers
security: []
responses:
'200':
description: List of phone numbers
content:
application/json:
schema:
$ref: '#/components/schemas/NumbersListAvailableNumbersResponse'
/integrations:
get:
tags:
- Integrations
summary: >-
List available inbound and outbound integrations. Note: this resource is
paginated.
operationId: Integrations_listAvailable
security: []
parameters:
- $ref: '#/components/parameters/start-index'
- $ref: '#/components/parameters/max-results'
responses:
'200':
description: list of integrations
content:
application/json:
schema:
$ref: '#/components/schemas/IntegrationsListAvailableResponse'
/users:
get:
tags:
- Users
summary: List existing users.
operationId: Users_listExistingUsers
parameters:
- $ref: '#/components/parameters/start-index'
- $ref: '#/components/parameters/max-results'
responses:
'200':
description: list of users
content:
application/json:
schema:
$ref: '#/components/schemas/UsersListExistingUsersResponse'
post:
tags:
- Users
summary: Create a new user. Requires ADMIN privileges.
operationId: Users_createNewUser
description: |
**Sample request**
```json
Request URL: https://api.ilert.com/api/users
{
"firstName": "John",
"lastName": "Doe",
"email": "john@acme.com",
"position": "Software Engineer",
}
```
**Response**
````json
{
"id": 2188373,
"firstName": "John",
"lastName": "Doe",
"email": "john@acme.com",
"position": "Software Engineer",
"timezone": "Europe/Berlin",
"language": "de",
"role": "RESPONDER",
}
````
requestBody:
description: the user object
content:
application/json:
schema:
$ref: '#/components/schemas/UserPost'
responses:
'201':
description: >-
Created. The URI of the created user entity is included in the
Location header and the user object is included in the body.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
/users/current:
get:
tags:
- Users
summary: Get the currently authenticated user.
operationId: Users_getCurrentUser
responses:
'200':
description: user object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
put:
tags:
- Users
summary: Update the current user.
operationId: Users_updateCurrentUser
requestBody:
description: user object
content:
application/json:
schema:
$ref: '#/components/schemas/UserPost'
responses:
'200':
description: the updated user
content:
application/json:
schema:
$ref: '#/components/schemas/User'
/alerts:
post:
tags:
- Alerts
summary: >-
Create alerts with customised parameters without requiring events from
monitoring tools that use our Events API.
operationId: Alerts_createCustomizedAlert
description: >-
Escalation of the alert will be based on the alert source's escalation
policy or may be overridden by providing a specific escalation policy or
lastly specific set of responders (users), latter will only notify the
user(s) and will not escalate any further.
requestBody:
description: the alert
content:
application/json:
schema:
$ref: '#/components/schemas/ManualAlert'
required: true
responses:
'201':
description: the created and freshly escalated alert
content:
application/json:
schema:
$ref: '#/components/schemas/Alert'
get:
tags:
- Alerts
summary: >-
List alerts (optionally matching certain criteria that are specified by
query parameters).
operationId: Alerts_listMatchingCriteria
description: >-
**Sample URLs**
* List only alerts that are either in state `PENDING` or `ACCEPTED`: <br
/> https://api.ilert.com/api/alerts?states=PENDING&states=ACCEPTED
* List only alerts that belong to the alert source with ID `1243` or
`1743` and where user `jd` is a responder: <br />
https://api.ilert.com/api/alerts?sources=1243&sources=1743&responders=jd
* Paginate first batch for a range of alerts (note: query parameters
should be url encoded): <br />
https://api.ilert.com/api/alerts?start-index=0&max-results=100&from=2021-03-01T21:24:56.771Z&until=2021-04-01T21:24:56.771Z
* Fetch next page, assuming equal to max-results were returned: <br/>
https://api.ilert.com/api/alerts?start-index=100&max-results=100&from=2021-03-01T21:24:56.771Z&until=2021-04-01T21:24:56.771Z
* Pagination should be done based on the `reportTime` field using the
parameters `from` and `until` as well as `start-index`. When building a
local alert state store the `id` field should be used as identifier. The
`alertKey` field is not suitable for this, as it is used to group
related alerts to each other.
parameters:
- $ref: '#/components/parameters/start-index'
- $ref: '#/components/parameters/max-results'
- description: >-
Describes optional properties that should be included in the
response. You may declare multiple. (nextEscalationUser)
name: include
in: query
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- nextEscalationUser
- description: state of the alert
in: query
name: states
explode: true
schema:
type: array
items:
type: string
enum:
- PENDING
- ACCEPTED
- RESOLVED
- description: alert source IDs of the alert's alert source
in: query
name: sources
explode: true
schema:
type: array
items:
type: integer
format: int64
- description: escalation policy IDs of the alert's escalation policy
in: query
name: policies
explode: true
schema:
type: array
items:
type: integer
format: int64
- description: user ids of the user that is a responder of the alert
in: query
name: responders
explode: true
schema:
type: array
items:
type: string
- description: >-
from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on
reportTime
in: query
name: from
schema:
type: string
format: date-time
- description: >-
until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on
reportTime
in: query
name: until
schema:
type: string
format: date-time
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsListMatchingCriteriaResponse'
/alerts/count:
get:
tags:
- Alerts
summary: Get the alert count matching the specified criteria.
operationId: Alerts_getAlertCountMatchingCriteria
parameters:
- description: state of the alert
in: query
name: states
explode: true
schema:
type: array
items:
type: string
enum:
- PENDING
- ACCEPTED
- RESOLVED
- description: alert source IDs of the alert's alert source
in: query
name: sources
explode: true
schema:
type: array
items:
type: integer
format: int64
- description: user ids of the user that is a responder of the alert
in: query
name: responders
explode: true
schema:
type: array
items:
type: string
- description: from date
in: query
name: from
schema:
type: string
format: date-time
- description: until date
in: query
name: until
schema:
type: string
format: date-time
responses:
'200':
description: the number of alerts matching the specified criteria
content:
application/json:
schema:
$ref: '#/components/schemas/CountResponse'
/alerts/{id}:
get:
tags:
- Alerts
summary: Get the alert with the specified id.
operationId: Alerts_getById
parameters:
- $ref: '#/components/parameters/id'
- description: >-
Describes optional properties that should be included in the
response. You may declare multiple. (escalationRules,
nextEscalationUser)
name: include
in: query
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- escalationRules
- nextEscalationUser
responses:
'200':
description: alert object
content:
application/json:
schema:
$ref: '#/components/schemas/Alert'
/alerts/{id}/suggested-responders:
get:
tags:
- Alerts
summary: >-
Get available (assignable) responders for the alert with the specified
id.
operationId: Alerts_getAssignableResponders
parameters:
- $ref: '#/components/parameters/id'
- description: locale for response text eg. 'en' or 'de'
name: lang
in: query
schema:
type: string
responses:
'200':
description: the list of alert responders
content:
application/json:
schema:
$ref: '#/components/schemas/AlertsGetAssignableRespondersResponse'
/alerts/{id}/responders:
post:
tags: