-
Notifications
You must be signed in to change notification settings - Fork 40
/
manager.spec.yaml
3811 lines (3693 loc) · 134 KB
/
manager.spec.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: Vulnerability Engine Manager
version: {{ app_version }}
paths:
/apistatus:
get:
summary: Determine the health of the application
description: Checks database availability and API response threshold time.
operationId: manager.api_status_handler.GetApiStatus.get
x-methodName: getApiStatus
responses:
200:
description: API is healthy
503:
description: Database is unavaiable
/version:
get:
summary: Get application version
description: >
This endpoint will provide you with the application version. Use this endpoint
to track application changes.
operationId: manager.version_handler.GetVersion.get
x-methodName: getVersion
responses:
200:
description: Application version.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/VersionOut'
/business_risk:
get:
summary: Access business risk values
description: >
This endpoint helps you determine the numeric business risk for a given CVE.
A business risk is a label you can set for a given CVE. Choose one of five business risk
options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk.
You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint.
operationId: manager.risk_handler.GetRisk.get
x-methodName: getBusinessRiskList
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: List of business risk/business_risk_id pairs.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/BusinessRiskListOut'
/cves/{cve_id}:
get:
summary: Get CVE details
description: >
This endpoint returns the CVE identification number, description, scores
and other metadata. The metadata includes the description, CVSS 2/3 Score,
CVSS 2/3 attack vector, severity, public date, modified date, business risk,
status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and
information regarding known exploits for the CVE.
operationId: manager.cve_handler.GetCves.get
x-methodName: getCveDetails
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: CVE details
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CveDetailOut'
404:
description: Given CVE does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- $ref: '#/components/parameters/cve_id'
- $ref: '#/components/parameters/advisory_available'
/cves/{cve_id}/affected_systems:
get:
summary: Determine affected systems for a given CVE
description: >
This is a report of affected systems for a given CVE.
Use this request to obtain server identification numbers of all affected servers along
with last check-in, system name and more.
operationId: manager.cve_handler.GetCvesAffectedSystems.get
x-methodName: getAffectedSystemsByCve
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Report of affected systems for a given CVE.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AffectedSystemsOut'
404:
description: Given CVE does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/cve_id'
- $ref: '#/components/parameters/status_id'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/uuid'
- $ref: '#/components/parameters/rule_key_deprecated'
- $ref: '#/components/parameters/rule_presence_deprecated'
- $ref: '#/components/parameters/rule'
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/show_advisories'
- $ref: '#/components/parameters/advisory'
- $ref: '#/components/parameters/rhel_version'
- $ref: '#/components/parameters/first_reported_from'
- $ref: '#/components/parameters/first_reported_to'
- $ref: '#/components/parameters/advisory_available'
- $ref: '#/components/parameters/remediation'
- $ref: '#/components/parameters/report'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
- $ref: '#/components/parameters/group_names'
- $ref: '#/components/parameters/group_ids'
- $ref: '#/components/parameters/host_type'
/cves/{cve_id}/affected_systems/ids:
get:
summary: Get identification numbers of affected systems for a given CVE
description: >
This is a report of identification numbers of affected systems for a given CVE.
Use this request to obtain server identification numbers of all affected systems.
operationId: manager.cve_handler.GetCvesAffectedSystemsIds.get
x-methodName: getAffectedSystemsIdsByCve
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Report of IDs of affected systems for a given CVE.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AffectedSystemsIdsOut'
404:
description: Given CVE does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/cve_id'
- $ref: '#/components/parameters/status_id'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/uuid'
- $ref: '#/components/parameters/rule_key_deprecated'
- $ref: '#/components/parameters/rule_presence_deprecated'
- $ref: '#/components/parameters/rule'
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/show_advisories'
- $ref: '#/components/parameters/advisory'
- $ref: '#/components/parameters/rhel_version'
- $ref: '#/components/parameters/first_reported_from'
- $ref: '#/components/parameters/first_reported_to'
- $ref: '#/components/parameters/advisory_available'
- $ref: '#/components/parameters/remediation'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
- $ref: '#/components/parameters/group_names'
- $ref: '#/components/parameters/group_ids'
- $ref: '#/components/parameters/host_type'
/cves/business_risk:
patch:
summary: Set business risk for a CVE
description: >
This sets a business risk for a specific CVE. Set a value of low,
medium, high or critical for a given CVE. These values are obtained by the business
risk path *GET/business_risk*. To set a business risk, you must call the
GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path.
operationId: manager.cve_handler.PatchCveRisk.patch
x-methodName: setCveBusinessRisk
security:
- ApiKeyAuth: []
- BasicAuth: []
requestBody:
description: Values to be set. At least one of the "business_risk_id" or "business_risk_text" parameters is required.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CveRiskIn'
x-body-name: data
responses:
200:
description: Business risk successfully updated.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/BulkChangeOut'
404:
description: Given CVE does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
503:
description: Service is running in read-only mode.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
/cves/status:
patch:
summary: Set status for a CVE
description: >
This sets the status for a specific CVE. Set a status
value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved).
These values are obtained by sending a *GET/status* request. To set a status, you
must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path.
operationId: manager.cve_handler.PatchCveStatus.patch
x-methodName: setCveStatus
security:
- ApiKeyAuth: []
- BasicAuth: []
requestBody:
description: Values to be set. At least one of the "status_id" or "status_text" parameters is required.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CveStatusIn'
x-body-name: data
responses:
200:
description: Status successfully updated.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/BulkChangeOut'
404:
description: Given CVE does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
503:
description: Service is running in read-only mode.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
/dashboard:
get:
summary: Get a macro level overview of aggregated vulnerabilities
description: >
These are aggregations summarizing your account such as number
of unique CVEs, list of security rules, CVEs by severity, and more.
Use this endpoint to obtain a snapshot of all the CVES and details about their
prevalence and severity.
operationId: manager.dashboard_handler.GetDashboard.get
x-methodName: getDashboard
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Dashboard.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Dashboard'
parameters:
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
/playbooks/templates/{rule_id}:
get:
summary: Get an Ansible Playbook template for CVEs with security rules
description: >
This returns an Ansible playbook template for a given rule identification
number. Use this endpoint to return an Ansible playbook template for a given rule
error key. The template is used to remediate issues on your system.
operationId: manager.playbook_handler.GetTemplate.get
x-methodName: getPlaybookTemplate
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Playbook template response
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PlaybookTemplate'
404:
description: Given rule id does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- in: path
name: rule_id
description: Insights security rule ID.
required: true
schema:
type: string
example: CVE_2017_8779_rpc|CVE_2017_8779_WARN
/report/executive:
get:
summary: Generate an executive report
description: >
This returns an overview of vulnerabilities affecting a given account.
Use this request when you need to download a high-level, executive report summarizing
the security exposure of your infrastructure. These reports are designed for an executive
audience and include data such as the number of RHEL systems analyzed, the number of
security rules in your infrastructure, percentage of CVEs with a certain severity and more.
operationId: manager.report_handler.GetExecutive.get
x-methodName: getExecutiveReport
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Executive report.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ExecutiveReport'
/status:
get:
summary: Access available status values
description: >
This endpoint returns a list of possible
values for setting status for a CVE or system-CVE pair.
Call this api when you want to know which values are available
for setting a status. A list of numbers will be returned.
You must call this endpoint before calling the *PATCH/cves/status* endpoint.
operationId: manager.status_handler.GetStatus.get
x-methodName: getStatusList
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: List of status/status_id pairs.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StatusListOut'
patch:
summary: Set status for system vulnerabilities
description: >
This endpoint sets status for given systems and CVEs. Use this endpoint when
you need to set a status value for system-CVE pairs.
operationId: manager.status_handler.PatchStatus.patch
x-methodName: setStatus
security:
- ApiKeyAuth: []
- BasicAuth: []
requestBody:
description: Values to be set.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StatusIn'
x-body-name: data
responses:
200:
description: Status successfully updated.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/StatusOut'
404:
description: Given host/CVE does not exist.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
503:
description: Service is running in read-only mode.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
/systems:
get:
summary: List systems
description: >
List systems that are accessible when you are logged into your account.
Use this endpoint to view basic system attributes such as display name and system type.
operationId: manager.system_handler.GetSystems.get
x-methodName: getSystemsList
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: System list
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SystemListOut'
parameters:
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/stale'
- $ref: '#/components/parameters/uuid'
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/excluded'
- $ref: '#/components/parameters/rhel_version'
- $ref: '#/components/parameters/report'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
- $ref: '#/components/parameters/group_names'
- $ref: '#/components/parameters/group_ids'
/systems/ids:
get:
summary: List systems identification numbers along with opt out state
description: >
This lists systems including those that have opted out of the current query.
Use this when you do not want to see a registered system or systems in your reports.
operationId: manager.system_handler.GetSystemsIds.get
x-methodName: getSystemsIds
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: System list
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SystemIdsOut'
parameters:
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/stale'
- $ref: '#/components/parameters/uuid'
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/excluded'
- $ref: '#/components/parameters/rhel_version'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
- $ref: '#/components/parameters/group_names'
- $ref: '#/components/parameters/group_ids'
/systems/{inventory_id}:
get:
summary: Get system details
description: >
This allows you to get information
about systems related to an inventory identification number. This includes
details such as operating system, inventory tags, last update, opt-out status,
and more.
operationId: manager.system_handler.GetSystemDetails.get
x-methodName: getSystemDetails
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: System details
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SystemDetailsOut'
404:
description: System has not been found in the database.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- $ref: '#/components/parameters/inventory_id'
/systems/{inventory_id}/cves:
get:
summary: Get a CVE report for a system
description: >
This endpoint displays detailed information about all CVEs
for which a system is exposed. Use this endpoint to discover which CVEs
are affecting a given system. CVE metadata is included.
operationId: manager.system_handler.GetSystemsCves.get
x-methodName: getCveListBySystem
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: CVE report.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SystemCvesOut'
404:
description: System has not been found in the database.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- $ref: '#/components/parameters/inventory_id'
- $ref: '#/components/parameters/cve_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/cve_sort'
- $ref: '#/components/parameters/cvss_from'
- $ref: '#/components/parameters/cvss_to'
- $ref: '#/components/parameters/public_from'
- $ref: '#/components/parameters/public_to'
- $ref: '#/components/parameters/impact'
- $ref: '#/components/parameters/status_id'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/business_risk_id'
- $ref: '#/components/parameters/rule_presence'
- $ref: '#/components/parameters/show_advisories'
- $ref: '#/components/parameters/advisory'
- $ref: '#/components/parameters/rule_key'
- $ref: '#/components/parameters/known_exploit'
- $ref: '#/components/parameters/first_reported_from'
- $ref: '#/components/parameters/first_reported_to'
- $ref: '#/components/parameters/advisory_available'
- $ref: '#/components/parameters/remediation'
- $ref: '#/components/parameters/report'
/systems/{inventory_id}/cves/ids:
get:
summary: Get a CVE identification number report for a system
description: >
This endpoint displays identification numbers of all CVEs for which
a system is exposed. Use this endpoint to learn which CVEs are
affecting a given system.
operationId: manager.system_handler.GetSystemsCvesIds.get
x-methodName: getCveIdsBySystem
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: CVE Ids report.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/SystemCvesIdsOut'
404:
description: System has not been found in the database.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
- $ref: '#/components/parameters/inventory_id'
- $ref: '#/components/parameters/cve_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/cve_sort'
- $ref: '#/components/parameters/cvss_from'
- $ref: '#/components/parameters/cvss_to'
- $ref: '#/components/parameters/public_from'
- $ref: '#/components/parameters/public_to'
- $ref: '#/components/parameters/impact'
- $ref: '#/components/parameters/status_id'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/business_risk_id'
- $ref: '#/components/parameters/rule_presence'
- $ref: '#/components/parameters/show_advisories'
- $ref: '#/components/parameters/advisory'
- $ref: '#/components/parameters/rule_key'
- $ref: '#/components/parameters/known_exploit'
- $ref: '#/components/parameters/first_reported_from'
- $ref: '#/components/parameters/first_reported_to'
- $ref: '#/components/parameters/advisory_available'
- $ref: '#/components/parameters/remediation'
/systems/opt_out:
patch:
summary: Opt a system in or out of the vulnerability service
description: >
Opt a specific system in or out of vulnerability analysis.
Use this when you want to use other Insights services but do not want
to see specific systems in vulnerability reports. This allows you to
hide select systems.
operationId: manager.system_handler.PatchBulkSystemsOptOut.patch
x-methodName: setSystemsOptOut
security:
- ApiKeyAuth: []
- BasicAuth: []
requestBody:
description: Values to be set.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/OptOutIn'
x-body-name: data
responses:
200:
description: System(s) setting has been updated.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/BulkChangeOut'
503:
description: Service is running in read-only mode.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Errors'
/vulnerabilities/cves:
get:
summary: Get a vulnerabilities overview
description: >
This provides an overview of vulnerabilities across your entire system inventory.
Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE
metadata, how many systems are affected by each CVE, and more.
operationId: manager.vulnerabilities_handler.GetCves.get
x-methodName: getCveList
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Vulnerabilities overview.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/VulnerabilitiesOut'
parameters:
- $ref: '#/components/parameters/cve_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/cve_sort'
- $ref: '#/components/parameters/cvss_from'
- $ref: '#/components/parameters/cvss_to'
- $ref: '#/components/parameters/public_from'
- $ref: '#/components/parameters/public_to'
- $ref: '#/components/parameters/impact'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/business_risk_id'
- $ref: '#/components/parameters/status_id'
- $ref: '#/components/parameters/rule_presence'
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/known_exploit'
- $ref: '#/components/parameters/affecting'
- $ref: '#/components/parameters/rhel_version'
- $ref: '#/components/parameters/report'
- $ref: '#/components/parameters/advanced_report'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
- $ref: '#/components/parameters/advisory_available'
- $ref: '#/components/parameters/group_names'
- $ref: '#/components/parameters/group_ids'
- $ref: '#/components/parameters/affecting_host_type'
post:
summary: Send a vulnerabilities overview
description: >
This is an overview of vulnerabilities for specific CVEs provided in the body.
Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided
in the request.
operationId: manager.vulnerabilities_handler.PostCves.post
x-methodName: getCveList
security:
- ApiKeyAuth: []
- BasicAuth: []
requestBody:
description: List of CVEs to provide info about.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/VulnerabilitiesPostIn'
x-body-name: data
responses:
200:
description: Vulnerabilities overview.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/VulnerabilitiesPostOut'
parameters:
- $ref: '#/components/parameters/cve_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/sort'
/vulnerabilities/cves/ids:
get:
summary: Get an overview of Vulnerabilities' identification numbers
description: >
This is an overview of vulnerabilities identification numbers
across your entire system inventory.
Use this endpoint to get an overview of which CVEs are affecting your account.
operationId: manager.vulnerabilities_handler.GetCvesIds.get
x-methodName: getCveIdsList
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Vulnerabilities IDs overview.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/VulnerabilitiesIdsOut'
parameters:
- $ref: '#/components/parameters/cve_filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/cve_sort'
- $ref: '#/components/parameters/cvss_from'
- $ref: '#/components/parameters/cvss_to'
- $ref: '#/components/parameters/public_from'
- $ref: '#/components/parameters/public_to'
- $ref: '#/components/parameters/impact'
- $ref: '#/components/parameters/data_format'
- $ref: '#/components/parameters/business_risk_id'
- $ref: '#/components/parameters/status_id'
- $ref: '#/components/parameters/rule_presence'
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/known_exploit'
- $ref: '#/components/parameters/affecting'
- $ref: '#/components/parameters/rhel_version'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
- $ref: '#/components/parameters/advisory_available'
/announcement:
get:
summary: Announce important updates
description: >
This endpoint provides vulnerability service announcements. Remain informed about important alerts
for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts.
operationId: manager.announcement_handler.GetAnnouncement.get
x-methodName: getAnnouncement
responses:
200:
description: Announcement.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AnnouncementOut'
/dashbar:
get:
summary: Get aggregations for the dashbar
description: >
These are aggregations summarizing your account such as number
of unique CVEs, list of security rules, CVEs by severity and more. Use this
endpoint to obtain a snapshot of all the CVES and details about their prevalence,
severity and other details.
operationId: manager.dashbar_handler.GetDashbar.get
x-methodName: getDashbar
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Dashbar aggregations.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/DashbarOut'
parameters:
- $ref: '#/components/parameters/tags'
- $ref: '#/components/parameters/sap_sids'
- $ref: '#/components/parameters/sap_system'
- $ref: '#/components/parameters/ansible'
- $ref: '#/components/parameters/mssql'
/feature/cves_without_errata:
patch:
summary: Set a feature flag for CVEs without errata
description: >
Use this endpoint to enable/disable reporting CVEs that do not have advisories
(errata) for your customer account. If the feature is disabled, CVEs without advisories
will be hidden in outputs of all endpoints.
operationId: manager.feature_handler.PatchCvesWithoutErrata.patch
x-methodName: setCvesWithoutErrata
security:
- ApiKeyAuth: []
- BasicAuth: []
requestBody:
description: Values to be set.
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CvesWithoutErrataIn'
x-body-name: data
responses:
200:
description: CVEs without Errata feature successfully updated.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CvesWithoutErrataOut'
/notifications:
delete:
summary: Delete already sent notifications for CVEs
description: >
Use this endpoint for restarting your already obtained notifications for CVEs.
operationId: manager.feature_handler.DeleteNotifications.delete
x-methodName: deleteNotifications
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: Sent notifications deleted.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/NotificationsOut'
403:
description: Non-existing account.
components:
parameters:
filter:
in: query
name: filter
description: Full text filter for the display name of system.
schema:
type: string
example: INV-ID-1234
cve_filter:
in: query
name: filter
description: Full text filter for CVE and it's description text.
schema:
type: string
example: CVE-2017
limit:
in: query
name: limit
description: Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.
schema:
type: integer
maximum: 9007199254740991 # JS Number.MAX_SAFE_INTEGER (used by exports on FE), not to overflow DB storage type
minimum: 1
example: 25
offset:
in: query
name: offset
description: Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.
schema:
type: integer
maximum: 9007199254740991 # JS Number.MAX_SAFE_INTEGER (used by exports on FE), not to overflow DB storage type
minimum: 0
example: 1
page:
in: query
name: page
description: Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.
schema:
type: integer
maximum: 9007199254740991 # JS Number.MAX_SAFE_INTEGER (used by exports on FE), not to overflow DB storage type
minimum: 1
example: 1
page_size:
in: query
name: page_size
description: Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.
schema:
type: integer
maximum: 9007199254740991 # JS Number.MAX_SAFE_INTEGER (used by exports on FE), not to overflow DB storage type
minimum: 1
example: 25
sort:
in: query
name: sort
description: Sorting used for response.
schema:
type: string
example: -inventory_id
cve_sort:
in: query
name: sort
description: Sorting used for response.
schema:
type: string
example: -synopsis
inventory_id:
in: path
name: inventory_id
description: Inventory ID.
required: true
schema:
type: string
format: uuid
example: INV-ID-0000-1234
cve_id:
in: path
name: cve_id
description: CVE id.
required: true
schema:
type: string
example: CVE-2016-0800
public_from:
in: query
name: public_from
description: Filter CVEs based on their published date, starting from the date.
schema:
type: string
example: '2017-09-18T00:00:00+00:00'
public_to:
in: query
name: public_to
description: Filter CVEs based on their published date, up to the date.
schema:
type: string
example: '2017-09-18T00:00:00+00:00'
cvss_from:
in: query
name: cvss_from
description: Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.