forked from RedHatProductSecurity/osidb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
2779 lines (2764 loc) · 70 KB
/
openapi.yml
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.3
info:
title: OSIDB API
version: 2.3.4
description: REST API autogenerated docs for the OSIDB and its components
paths:
/auth/token:
get:
operationId: auth_token_retrieve
description: Takes a kerberos ticket and returns an access and refresh JWT pair.
tags:
- auth
security:
- KerberosAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
access:
type: string
dt:
type: string
format: date-time
env:
type: string
refresh:
type: string
revision:
type: string
version:
type: string
description: ''
post:
operationId: auth_token_create
description: |-
Takes a set of user credentials and returns an access and refresh JSON web
token pair to prove the authentication of those credentials.
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenObtainPair'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenObtainPair'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenObtainPair'
required: true
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TokenObtainPair'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/auth/token/refresh:
post:
operationId: auth_token_refresh_create
description: |-
Takes a refresh type JSON web token and returns an access type JSON web
token if the refresh token is valid.
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenRefresh'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenRefresh'
required: true
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TokenRefresh'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/auth/token/verify:
post:
operationId: auth_token_verify_create
description: |-
Takes a token and indicates if it is valid. This view provides no
information about a token's fitness for a particular use.
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenVerify'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenVerify'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenVerify'
required: true
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TokenVerify'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/collectors/:
get:
operationId: collectors_retrieve
description: index API endpoint listing available collector API endpoints
tags:
- collectors
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
index:
type: array
items:
type: string
revision:
type: string
version:
type: string
description: ''
/collectors/api/v1/status:
get:
operationId: collectors_api_v1_status_retrieve
description: get the overall status of all collectors and the collected data
tags:
- collectors
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
collectors:
type: array
items:
type: object
properties:
data:
type: string
enum:
- EMPTY
- PARTIAL
- COMPLETE
depends_on:
type: array
items:
type: string
error:
type: object
nullable: true
is_complete:
type: boolean
data_models:
type: array
items:
type: string
state:
type: string
enum:
- PENDING
- BLOCKED
- READY
- RUNNING
updated_until:
type: string
format: date-time
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/collectors/healthy:
get:
operationId: collectors_healthy_retrieve
description: unauthenticated health check API endpoint
tags:
- collectors
security:
- OsidbTokenAuthentication: []
- {}
responses:
'200':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/collect:
put:
operationId: exploits_api_v1_collect_update
description: |-
API endpoint for re-collecting exploit data.
**NOTE:** Currently for CISA data only, which is very small and collection is fast.
tags:
- exploits
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
result_cisa:
type: string
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/cve_map:
get:
operationId: exploits_api_v1_cve_map_retrieve
description: |-
API endpoint for getting simple exploits information mapped to impacted CVEs.
The Insights Vulnerability application needs this format.
Format of results:
```
{
"page_size": <Number of CVEs on the page>,
"cves": {
"CVE-2222-0001": [<List of exploits>],
"CVE-2222-0002": [<List of exploits>],
...
},
}
```
tags:
- exploits
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
cves:
type: object
dt:
type: string
format: date-time
env:
type: string
page_size:
type: integer
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/epss:
get:
operationId: exploits_api_v1_epss_list
description: API endpoint for getting list of Red Hat relevant CVEs with their
EPSS score.
parameters:
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
tags:
- exploits
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedEPSSList'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/report/date/{date}:
get:
operationId: exploits_api_v1_report_date_retrieve
description: |-
API endpoint for getting date based report for Incident Response.
Format of results:
```
{
"cutoff_date": <Date>,
"evaluated_cves": <Number of new CVEs with exploits>,
"action_required": [<List of affects requiring action>],
"no_action": [<List of CVEs not requiring action with reason>],
"not_relevant": [<List of CVEs which are not in the database with reason>],
}
```
**NOTE:** No pagination is performed on this endpoint as data is limited by date and is expected
to be fairly small. Also, because data is broken into three categories it is not
exactly obvious how to create pages.
parameters:
- in: path
name: date
schema:
type: string
format: date
description: 'Date format: YYYY-MM-DD'
required: true
tags:
- exploits
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
action_required:
type: array
items:
type: object
cutoff_date:
type: string
dt:
type: string
format: date-time
env:
type: string
evaluated_cves:
type: integer
no_action:
type: array
items:
type: object
not_relevant:
type: array
items:
type: object
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/report/explanations:
get:
operationId: exploits_api_v1_report_explanations_retrieve
description: |-
API endpoint for getting a report of all CVEs with exploit and their status
for Incident Response.
Format of results:
```
{
"page_size": <Number of CVEs on the page>,
"explanations": [<List of CVEs with exploit together with current status explanation>],
}
```
tags:
- exploits
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
explanations:
type: array
items:
type: object
page_size:
type: integer
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/report/pending:
get:
operationId: exploits_api_v1_report_pending_retrieve
description: |-
API endpoint for getting a report of pending actions for Incident Response.
Format of results:
```
{
"pending_actions": [<List of affects requiring action>],
"pending_actions_count": <Number of affects requiring action>,
}
```
**NOTE:** No pagination is performed on this endpoint as it is expected that the size of
the list of pending actions will be mostly stable. Also, the paging cannot be done on
the query level, as additional analysis of every exploit is required before a decision
to include it in this report is done.
tags:
- exploits
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
pending_actions:
type: array
items:
type: object
pending_actions_count:
type: integer
revision:
type: string
version:
type: string
description: ''
/exploits/api/v1/status:
get:
operationId: exploits_api_v1_status_retrieve
description: |-
API endpoint for getting basic information about exploits in the database.
**NOTE:** Everyone is allowed to see basic information.
tags:
- exploits
security:
- OsidbTokenAuthentication: []
- {}
responses:
'200':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
exploits_count:
type: integer
exploits_count_relevant:
type: integer
last_exploit:
type: integer
revision:
type: string
version:
type: string
description: ''
/osidb/api/v1/affects:
get:
operationId: osidb_api_v1_affects_list
parameters:
- in: query
name: affectedness
schema:
type: string
enum:
- ''
- AFFECTED
- NEW
- NOTAFFECTED
- in: query
name: flaw
schema:
type: string
format: uuid
- in: query
name: impact
schema:
type: string
enum:
- ''
- CRITICAL
- IMPORTANT
- LOW
- MODERATE
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: ps_component
schema:
type: string
- in: query
name: ps_module
schema:
type: string
- in: query
name: resolution
schema:
type: string
enum:
- ''
- DEFER
- DELEGATED
- FIX
- OOSS
- WONTFIX
- WONTREPORT
- in: query
name: type
schema:
type: string
enum:
- DEFAULT
- in: query
name: uuid
schema:
type: string
format: uuid
tags:
- osidb
security:
- OsidbTokenAuthentication: []
- {}
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginatedAffectList'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
post:
operationId: osidb_api_v1_affects_create
tags:
- osidb
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Affect'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Affect'
multipart/form-data:
schema:
$ref: '#/components/schemas/Affect'
required: true
security:
- OsidbTokenAuthentication: []
responses:
'201':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Affect'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/osidb/api/v1/affects/{uuid}:
get:
operationId: osidb_api_v1_affects_retrieve
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: A UUID string identifying this Affect.
required: true
tags:
- osidb
security:
- OsidbTokenAuthentication: []
- {}
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Affect'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
put:
operationId: osidb_api_v1_affects_update
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: A UUID string identifying this Affect.
required: true
tags:
- osidb
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Affect'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Affect'
multipart/form-data:
schema:
$ref: '#/components/schemas/Affect'
required: true
security:
- OsidbTokenAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Affect'
- type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
delete:
operationId: osidb_api_v1_affects_destroy
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: A UUID string identifying this Affect.
required: true
tags:
- osidb
security:
- OsidbTokenAuthentication: []
responses:
'204':
content:
application/json:
schema:
type: object
properties:
dt:
type: string
format: date-time
env:
type: string
revision:
type: string
version:
type: string
description: ''
/osidb/api/v1/flaws:
get:
operationId: osidb_api_v1_flaws_list
parameters:
- in: query
name: bz_id
schema:
type: number
- in: query
name: changed_after
schema:
type: string
format: date-time
- in: query
name: changed_before
schema:
type: string
format: date-time
- in: query
name: created_dt
schema:
type: string
format: date-time
- in: query
name: cve_id
schema:
type: array
items:
type: string
description: Multiple values may be separated by commas.
explode: false
style: form
- in: query
name: cvss2
schema:
type: string
- in: query
name: cvss2_score
schema:
type: number
format: float
- in: query
name: cvss3
schema:
type: string
- in: query
name: cvss3_score
schema:
type: number
format: float
- in: query
name: cwe_id
schema:
type: string
- in: query
name: description
schema:
type: string
- in: query
name: embargoed
schema:
type: boolean
- in: query
name: exclude_fields
schema:
type: array
items:
type: string
description: 'Exclude specified fields from the response. Multiple values
may be separated by commas. Dot notation can be used to filter on related
model fields. Example: `exclude_fields=uuid,affects.uuid,affects.trackers.uuid`'
- in: query
name: flaw_meta_type
schema:
type: array
items:
type: string
description: 'Include flaw metas with specified type only, multiple values
may be separated by commas. '
- in: query
name: impact
schema:
type: string
enum:
- ''
- CRITICAL
- IMPORTANT
- LOW
- MODERATE
- in: query
name: include_fields
schema:
type: array
items:
type: string
description: 'Include only specified fields in the response. Multiple values
may be separated by commas. Dot notation can be used to filter on related
model fields. Example: `include_fields=uuid,affects.uuid,affects.trackers.uuid`'
- in: query
name: include_meta_attr
schema:
type: array
items:
type: string
description: 'Specify which keys from meta_attr field should be retrieved,
multiple values may be separated by commas. Dot notation can be used to
specify meta_attr keys on related models. Example: `include_meta_attr=bz_id,affects.ps_module,affects.trackers.bz_id`Use
wildcards eg. `include_meta_attr=*,affects.*,affects.trackers.*` for retrieving
all the keys from meta_attr. Omit this parameter to not include meta_attr
fields at all. '
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- in: query
name: reported_dt
schema:
type: string
format: date-time
- in: query
name: resolution
schema:
type: string
enum:
- ''
- CANTFIX
- CURRENTRELEASE
- DEFERRED
- DUPLICATE
- EOL
- ERRATA
- INSUFFICIENT_DATA
- NEXTRELEASE
- NOTABUG
- RAWHIDE
- UPSTREAM
- WONTFIX
- WORKSFORME
- in: query
name: search
schema:
type: string
- in: query
name: source
schema:
type: string
enum:
- ''
- ADOBE
- APPLE
- ASF
- BIND
- BK
- BUGTRAQ
- BUGZILLA
- CERT
- CERTIFI
- CORELABS
- CUSTOMER
- CVE
- DAILYDAVE
- DEBIAN
- DISTROS
- FEDORA
- FETCHMAIL
- FREEDESKTOP
- FREERADIUS
- FRSIRT
- FULLDISCLOSURE
- GAIM
- GENTOO
- GENTOOBZ
- GIT
- GNOME
- GNUPG
- GOOGLE
- HP
- HW_VENDOR
- IBM
- IDEFENSE
- INTERNET
- ISC
- ISEC