forked from RedHatInsights/vulnerability-engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmanager.spec.yaml
2069 lines (1999 loc) · 69.4 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
paths:
/v1/version:
get:
summary: Application version
description: Get application version.
operationId: manager.version_handler.GetVersion.get
x-methodName: getVersion
responses:
200:
description: Application version.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/VersionOut'
/v1/business_risk:
get:
summary: Available business risk/business_risk_id pairs.
description: Returns available business risk and business_risk_id pairs where business_risk_id is internal ID of the business risk.
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'
/v1/cves/{cve_id}:
get:
summary: Details of a CVE.
description: Show all information about given 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'
/v1/cves/{cve_id}/affected_systems:
get:
summary: Affected systems for a given CVE.
description: Report of affected systems for a given CVE.
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'
- in: query
name: security_rule
description: Filter by presence (boolean) or name (string) of security rule.
schema:
type: string
example: CVE_2018_3639_cpu_kernel
/v1/cves/business_risk:
patch:
summary: Set business risk for a CVE.
description: Sets business risk for a CVE.
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'
/v1/cves/status:
patch:
summary: Set status for a CVE.
description: Sets status for a CVE.
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'
/v1/report/executive:
get:
summary: Top level overview of vulnerabilities.
description: Returns top level overview of vulnerabilities affecting given account.
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'
/v1/status:
get:
summary: Available status/status_id pairs.
description: Returns available status and status_id pairs where status_id is internal ID of the status.
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: Sets status for given hosts and CVEs.
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'
/v1/systems:
get:
summary: List systems.
description: List systems visible to logged in account with basic information related to vulnerabilities.
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'
- in: query
name: opt_out
description: If set to true, shows systems which have been opted out from vulnerability application. If not set defaults to false.
schema:
type: boolean
example: true
/v1/systems/{inventory_id}:
get:
summary: System details.
description: Provides details of a system, e.g. it's opt out status.
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'
- $ref: '#/components/parameters/stale'
delete:
summary: Delete system.
description: Deletes system from database.
operationId: manager.system_handler.DeleteSystem.delete
x-methodName: deleteSystem
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: System has been deleted.
404:
description: System has not been found in the database.
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'
parameters:
- $ref: '#/components/parameters/inventory_id'
/v1/systems/{inventory_id}/cves:
get:
summary: CVE report for a system.
description: Shows detailed information about all CVEs the system is exposed to.
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/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/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/stale'
- $ref: '#/components/parameters/security_rule'
/v1/systems/{inventory_id}/opt_out:
patch:
summary: Opt in/out a system to/from vulnerability application.
description: Opts in/out a systems. Opted out system is not shown and manageable by the vulnerability application.
operationId: manager.system_handler.PatchSystemsOptOut.patch
x-methodName: setSystemOptOut
deprecated: true
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
200:
description: System setting has been updated.
404:
description: System has not been found in the database.
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'
parameters:
- $ref: '#/components/parameters/inventory_id'
- in: query
name: value
description: opt_out setting of the host.
required: true
schema:
type: boolean
example: true
/v1/systems/opt_out:
patch:
summary: Opt in/out a system to/from vulnerability application.
description: Opts in/out a systems. Opted out system is not shown and manageable by the vulnerability application.
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'
/v1/vulnerabilities/cves:
get:
summary: Vulnerabilities overview.
description: Overview of vulnerabilities across whole host inventory.
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/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/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/security_rule'
- in: query
name: show_all
description: Show all known vulnerabilities, regardless of number of affected systems.
schema:
type: boolean
example: true
/v1/refresh/accounts/{account_id}:
put:
summary: Refresh cached counts for given account ID.
description: Refresh cached counts for given account ID. Admin interface, available only to internal users.
operationId: manager.refresh_handler.RefreshAccount.put
x-methodName: refreshAccount
security:
- ApiKeyAuthInternal: []
- BasicAuth: []
responses:
200:
description: Cached counts for given account successfully updated.
404:
description: Account was not found.
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'
parameters:
- $ref: '#/components/parameters/account_id'
tags:
- internal
/v1/refresh/accounts/{account_id}/cves/{cve_id}:
put:
summary: Refresh cached counts for given account ID and CVE.
description: Refresh cached counts for given account ID and CVE. Admin interface, available only to internal users.
operationId: manager.refresh_handler.RefreshAccountCve.put
x-methodName: refreshAccountCve
security:
- ApiKeyAuthInternal: []
- BasicAuth: []
responses:
200:
description: Cached counts for given account and CVE successfully updated.
404:
description: Account or CVE was not found.
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'
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/cve_id'
tags:
- internal
/v1/refresh/cves/{cve_id}:
put:
summary: Refresh cached counts for given CVE.
description: Refresh cached counts for given CVE. Admin interface, available only to internal users.
operationId: manager.refresh_handler.RefreshCve.put
x-methodName: refreshCve
security:
- ApiKeyAuthInternal: []
- BasicAuth: []
responses:
200:
description: Cached counts for given CVE successfully updated.
404:
description: CVE was not found.
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'
parameters:
- $ref: '#/components/parameters/cve_id'
tags:
- internal
/v1/refresh/systems/{inventory_id}:
put:
summary: Refresh cached counts for given inventory ID.
description: Refresh cached counts for given inventory ID. Admin interface, available only to internal users.
operationId: manager.refresh_handler.RefreshSystem.put
x-methodName: refreshSystem
security:
- ApiKeyAuthInternal: []
- BasicAuth: []
responses:
200:
description: Cached counts for given system successfully updated.
404:
description: System was not found.
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'
parameters:
- $ref: '#/components/parameters/inventory_id'
tags:
- internal
components:
parameters:
filter:
in: query
name: filter
description: Full text filter for the display name of system.
schema:
type: string
example: INV-ID-1234
limit:
in: query
name: limit
description: Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.
schema:
type: integer
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
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
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
example: 25
sort:
in: query
name: sort
description: Sorting used for response.
schema:
type: string
example: -inventory_id
inventory_id:
in: path
name: inventory_id
description: Inventory ID.
required: true
schema:
type: string
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.
schema:
type: number
example: 4.6
cvss_to:
in: query
name: cvss_to
description: Filter based on cvss score, up to the value.
schema:
type: number
example: 7.2
impact:
in: query
name: impact
description: Filter based on impact IDs.
schema:
type: string
example: '5,7'
status_id:
in: query
name: status_id
description: Filer based on CVE status ID.
schema:
type: string
example: '1,4'
business_risk_id:
in: query
name: business_risk_id
description: Filter based on business risk IDs.
schema:
type: string
example: 1,3
data_format:
in: query
name: data_format
description: Format of the output data, either JSON (default) or CSV.
schema:
type: string
example: json
account_id:
in: path
name: account_id
description: Account ID of user.
required: true
schema:
type: string
example: '123456'
stale:
in: query
name: stale
description: If set to true, shows stale systems. If not set defaults to false.
schema:
type: boolean
security_rule:
in: query
name: security_rule
description: If true shows only CVEs with security rule associated, if false shows CVEs without rules. When not set shows all CVEs.
schema:
type: boolean
example: true
uuid:
in: query
name: uuid
description: Filter based on UUID of inventory.
schema:
type: string
example: 2ee58c62-809f-11ea-bc55-0242ac130003
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: Username and password login.
x-basicInfoFunc: manager.base.basic_auth
ApiKeyAuth:
type: apiKey
in: header
name: x-rh-identity
description: Identity header provided by 3scale (for non-prod testing only).
x-apikeyInfoFunc: manager.base.auth
ApiKeyAuthInternal:
type: apiKey
in: header
name: x-rh-identity
description: Identity header provided by 3scale (for non-prod testing only).
x-apikeyInfoFunc: manager.base.auth_internal
schemas:
Errors:
type: object
properties:
errors:
type: array
items:
type: object
properties:
detail:
type: string
description: Error detail.
example: Record not found.
status:
type: string
description: String representation of HTTP status code.
example: 404
required:
- detail
- status
minItems: 1
required:
- errors
Links:
type: object
properties:
first:
type: string
description: Link to first page.
example: /api?offset=0&limit=1
last:
type: string
description: Link to last page.
example: /api?offset=7&limit=1
next:
type: string
description: Link to next page.
example: /api?offset=5&limit=1
nullable: true
previous:
type: string
description: Link to next page.
example: /api?offset=3&limit=1
nullable: true
required:
- first
- last
- next
- previous
Meta:
type: object
properties:
filter:
type: string
description: Full text filter
example: CVE-2016-0800
nullable: true
limit:
type: integer
description: Maximum number of paginated results.
example: 25
offset:
type: integer
description: First record of paginated response.
example: 0
page:
type: integer
description: Page number of paginated response.
example: 1
page_size:
type: integer
description: Number of records per page of paginated response.
example: 25
pages:
type: integer
description: Total number of pages of paginated response.
example: 1
sort:
type: string
description: Sorting filter.
example: -inventory_id
nullable: true
total_items:
type: integer
description: Total number of records.
example: 37
data_format:
type: string
description: Format of the output data, either JSON (default) or CSV.
example: JSON
required:
- filter
- limit
- offset
- page
- page_size
- pages
- sort
- total_items
- data_format
MetaVulnerabilitiesOut:
allOf:
- $ref: '#/components/schemas/Meta'
- type: object
properties:
business_risk_id:
type: string
description: Filter based on business risk IDs.
example: 1,3
nullable: true
cvss_from:
type: number
description: Filter based on cvss score, starting from the value.
example: 4.6
nullable: true
cvss_to:
type: number
description: Filter based on cvss score, up to the value.
example: 7.2
nullable: true
show_all:
type: boolean
description: Show all known vulnerabilities, regardless of number of affected systems.
example: true
nullable: true
public_from:
type: string
description: Filter CVEs based on their published date, starting from the date.
example: '2017-09-18T00:00:00+00:00'
nullable: true
public_to:
type: string
description: Filter CVEs based on their published date, up to the date.
example: '2017-09-18T00:00:00+00:00'
nullable: true
impact:
type: string
description: Filter based on impact IDs.
example: '5,7'
nullable: true
required:
- business_risk_id
- cvss_from
- cvss_to
- show_all
- public_from
- public_to
- impact
MetaAffectedSystems:
allOf:
- $ref: '#/components/schemas/Meta'
- type: object
properties:
status_id:
type: string
description: Filer based on CVE status ID.
example: '1,4'
nullable: true
required:
- status_id
MetaSystems:
allOf:
- $ref: '#/components/schemas/Meta'
- type: object
properties:
opt_out:
type: boolean
description: Whether the filter to show opted out systems is active or not. If not set, defaults to hiding opted out systems.
example: false
nullable: true
required:
- opt_out
MetaCves:
allOf:
- $ref: '#/components/schemas/Meta'
- type: object
properties:
business_risk_id:
type: string
description: Filter based on business risk IDs.
example: 1,3
nullable: true
cvss_from:
type: number
description: Filter based on cvss score, starting from the value.
example: 4.6
nullable: true
cvss_to:
type: number
description: Filter based on cvss score, up to the value.
example: 7.2
nullable: true
public_from:
type: string
description: Filter CVEs based on their published date, starting from the date.
example: '2017-09-18T00:00:00+00:00'
nullable: true
public_to:
type: string
description: Filter CVEs based on their published date, up to the date.
example: '2017-09-18T00:00:00+00:00'
nullable: true
impact:
type: string
description: Filter based on impact IDs.
example: '5,7'
nullable: true
status_id:
type: string
description: Filer based on CVE status ID.
example: '1,4'
nullable: true
required:
- business_risk_id
- cvss_from
- cvss_to
- public_from