forked from Shuffle/openapi-apps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathibm_x-force_api.yaml
2018 lines (1953 loc) · 74.4 KB
/
ibm_x-force_api.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
swagger: "3.0"
info:
title: IBM X-Force API
description: API based on https://exchange.xforce.ibmcloud.com/api/doc/?#!/Usage
version: "1.0"
x-logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAK4AAACuCAYAAACvDDbuAAASa0lEQVR4Xu2dB6wUVRfHL/aOqCBgw0CColLsvYsi2DExihWNMSYajbHGaIwx0Wg0RqPYFRsICCpYsWBDUSSigtHYpdh7V8zvfp79Zoe3O7tvZnbnnjk3MY88983ee89vz545/3PPdHHOLXE2bAcC24EuBm5gFrPp+h0wcA2EIHfAwA3SbDZpA9cYCHIHDNwgzWaTNnCNgSB3wMAN0mw2aQPXGAhyBwzcIM1mkzZwjYEgd8DADdJsNmkD1xgIcgcM3CDNZpM2cI2BIHfAwA3SbDZpA9cYCHIHDNwgzWaTNnCNgSB3wMAN0mw2aQPXGAhyBwzcIM1mkzZwjYEgd8DADdJsNmkD1xgIcgcM3CDNZpM2cI2BIHfAwA3SbDZpA9cYCHIHDNwgzWaTNnCNgSB3wMAN0mw2aQPXGAhyBwzcIM1mkzZwjYEgd8DADdJsNmkD1xgIcgcM3CDNZpM2cI2BIHfAwA3SbDZpA9cYCHIHDNwgzWaTNnCNgSB3wMDNyWzLLbec++eff/x/NrLfAQM34z1dbbXV3B577OEOO+wwt3jxYnffffe5uXPnur///jvjdyr35QzcjOy/+uqre2BHjx7t9txzTwfAjM8++8w98MADbuzYsR7gv/76K6N3LPdlDNyU9l9jjTU8qAC7++67V4CNXxaAJ02a5O68804P8J9//pnyncv95wZuJ+0PsPvss4874YQT3K677loT2OjllyxZ4hYsWOAefPBBD/CcOXPMA3dy/w3cJjeua9eubujQoRVgV1lllSav8L+XL1y40E2ePNndcccd7o033jAP3OQuGrgNbli3bt08sMcff7zbZZddXBKwv/76qyOzsPzyy9d9h0WLFnmA8cCzZ892f/zxR4MzKvfLDNwE+6+11loVD7vTTjslAvvjjz+6p556yt17772ud+/e7thjj3UDBw70ENcbZCCmTJniAX7ttdcM4AS7GLg1Nghg99tvP3/TtcMOO7iVV1657lb+8MMPHtjbbrvNPfvss+7nn392Xbp08fAecsghHuDBgwcnAvzFF1+4hx9+2N1+++1u1qxZBnCNXTdwYxuz9tpru/3339/HsNtvv71baaWV6gL73XffeWBvvfVWN2PGDPfLL790+PpevXpVAbzCCivUve5XX33lHnnkEf9BePXVV93vv/9e7tggtnoD978NWWedddyIESPccccd57bbbruGgH3iiSc8sC+88EJNYOO09ezZ0x188MH+fYYMGeIaAXjatGke4FdeecX99ttvBrBzrvTgdu/e3R1wwAEepG233datuOKKiR72scce88C+9NJLDQMbv+i6667rDjzwQH+zt9VWWyUC/PXXX7tHH33UA/zyyy+XHuDSgtujRw8PLOBss802ieB88803VeCQNchiROex9dZbJ35wvv32W4cHJgbmg5PVPLJYSyuvUTpw+aoWYBv1dAJKnp4Oz0+owgepEc8PwI8//rj3wC+++GKnPX8rYcvyvUoDbmdiy6lTp3rP1srYklh7+PDhHuA8Y+0sIWrHtdSDy938oYceWklHJQkCX375pQPYdt/Nk44D4EazG99//73Pbtxyyy3u+eef9+k4zUMtuChdRx11VNvyp/IBSVtMwzokPddMPvmmm25y06dPV1sLoRZc7tjvv//+ROFAFCtqBpBcs8qXcqN15JFH+oow8rBppVxR8BBEUPCSBBHqH4jlP//8c5WOVy24I0eO9EXctaTWvGsEKHUEWjzuQw895GPlLABec801KxJ0vZqJ+fPnu3333dd98sknBm5IO1ALXMoKpaglz6osisp5H8ofGaKECcBphQSpUuMmjrLKVVddtco88+bN85K1gRsStc65jsAFHuLep59+OvfYLw6ubB9CgmQrZs6cmVpIAOC9997bZyF22223Sl2wgRsYsDLdjsD99NNPfUnixx9/nPuqCBUoGBePG39DABYFLov8MEeH9tprr8rRITythQq5mzn7N2g3uDvvvLMHl7xsvYGQAMAiJKRVwgRgPqBXXXWVP3GhcZTq5qyVHpfDkuSPTzzxRC8pJ1WZiRJGDNxM0U4tKKm54GCm1tPFBm7O7giPSx6WGJQ8bCNFPFSd4YEREmqVSeY87cJf3sBtkYmo8x02bJhXwgA4yQNTmP7kk09W6ny1K2HNmsHAbXbHUr4eJUwA3nHHHROFBABGAaOM8rnnnnM//fRTyhno+HMDt012BGDu+vHAjZxlA+BnnnnGhxCk88oOsIHbJnDlbVHC6M/ATRyZiKTTwwArAOOJOZxZxmHgFsTqIiRQi9CREhafJjEvhzLxwFSF4ZHLNAzcglkbwUKUsHotnWTaAMwhTWJgPDCHN8swVINLbwMpsuGoOGoS3qwVyllaeKQnGTEw8rE00at1XdJmpM8AmGyEdoDVgkubz3vuucd3kqFn1zLLLOOBxYu1AlxO7/JhSVsmKW1LpQskyli9AcCcRaMel/4MaYt50n4A8/p71eDefffdFY8bBbcVFVMcuznppJN8i9EshAQApogGgKlJqFUDIaB8+OGHPu327rvv5sVOW6+rFlzkVnrSykkECRX42m0FuFJkg7dHCUPKJQ+bVgkDYOoQAJhsRC2AKSCn19k777zTVsDyenO14NL2CHAlxsXjAixAtQLceFmjKGFkAQA4rRJG2kwABlCyEtFh4Ob1kcn5uoBLA7m4x+WOvR3gynKlKZ4AnDYPyxEeAKYWAkEDYYNh4OYMWF6XB1zOkUWzClSH8fXaCnCT6nEBFiGBLAA/swAYBY4sBCcfKI/EE7/99tt5bXFbr6s2VDjooIN8cj4eKmBUAM57UIfAmTNaLdUbKGEICZKHTQswxTsATEXa9ddf7z744IO8l9qW66sFl1O+N998cxW4AEuvglaAy1c4HxIyC40qYcS+fNjIw6ZVwgiReFSV1eO25XPV+TflaPaYMWOqQgUeIMLv+dmq0ejDTWQ+ooSRhSiDkNBZO6j1uHjWG264YSlwiX1bCa4YBoDJNBCDRh8nVctwooThgUmnaVfCmgVYNbjXXXddFbjcaaOotQNcMYwoYQCMkJCkhHGTRVM7YmCa3HHEx4bi/rjcnFx77bVLgXv44YcXorsLfRCQnwXgeB42DicAcxoYD0yfXNqelnmo9bjcGF199dVV4PKIpiOOOKIQ4Ap0AMzNGwCTqmsEYPoxEAPT/pRj7mUcasElGX/llVcuBS4NQYp4ZBsljEJypFzmngQwxTsCMA1GaHZSpqEWXLzXFVdc4ZZddllvTyRfPC5PvykiuAIdaTTysAKwKGG1oARgepLhgXnYCW1SyzDUgou0e9lll1XlcWl0hzQKwEUfAIyIwXyp8qJbY70BwDwfTQCmC6XmoRZc7tgvvfTSqlABcBEEWgEu4OHt0x5qRAnjODsxMABzzL3eoJ3p66+/7sUX2qym7YxTVPjVgkuu9JJLLlkK3JNPPtkBcN4Db3naaae5CRMmeCGBjuFpBo1EeO4aAJMxSWrtJL3DaDeqcagFl1TTxRdfXBXjAuypp57aEnClyIZaiSyP1AAwDzcBYEQWHnrS0bDqsEA/rpwWuPDCCyvgUkhO3IcXbEX8F6/HRQmjJxgxKE3u0iphAEzXc2Jg6jLiABu4gYJLjeoFF1zgQwU5cwawZ5xxRlvAlW0UJQyAERLSKmGcbQNgsiVUxEk1moEbKLjkRM8999yqUAFwzzrrLMeDnvMeSfW4HGLkUCNKGB44rZBANRjPbeMJmTxylaowq8fN28o5XJ9c6Nlnn10VKgDsOeec0xJwuZHioOT6669fd3UAjJAAwFkoYQIwIgYnQD766KMcdrf9l1R7cwY4gCuhAjEuXg0v3IoYlxgUKZfWSng+Wi3VGwA8a9YsDzBCQloljFQcIRI1uRqHWnCJ++LgckN00UUXtaSQXGARJUyO1DSihAGwCAmtCGtCBFstuFtssYU777zzqjwuRdqXX365a0duE4CjQkKSEoaQAMB83fO4qVZ8S4QEsFpw+/bt684//3zf/ZCvTAYw3HjjjT6mbNdACSOMIY1FHrZRJYyDnwDcCvGkXXvTzPuqBZe0EDdiPXr0qMR5xLnjx4/3rYnaPUQJIwvAU9OTlDAe9Mdz2QghpkyZ4gGWD2S719KO91cLLl/NZ555puvfv3/lwCDgUozNaQIe7FGEIUqYAMwHrd4A4Dlz5vgQgqf6FLnSLc/9VQsukB5zzDG+3xZ31ngnfsexnWuuuSa1cpW1UaJKGAc6GwH4zTff9ABzDF7rM3tr7bNacFkw6tmoUaP82gGX/yj/o3KqqI0yUMK23HJLHwNHlbBaBuSbA4BpN0VBDwCXIYRQDe6GG27oi2o4kBj1ujxDga/ZIhsYIQGAkXJRwnr16lXXyaOUzZ071911112+nLEVpZtZf+s0cz3V4PL1iwCw6aab+jhXQMWoeN08Dxxymhf40tYicI0hQ4b4sIej9b17906MgU855RQfx2seqsHFcJQ38pUroQI/gZg7c2oF8hpSKzFx4sRMjtQA8KBBg7wHBuD11luvw6nzoSTNRgZC81APbs+ePf35LRQrCRcwKF3JafycttVRLTikyIbshpwJIw2XVglDwh44cKAHmB7AAMxNpwzCBOJjrZ3IZZ3qweWQJB4X1QpwBV68Lg02aLaRx4jX43JTyJEaERLSKmEAvPnmm/sQgiYnxPPU/HKKefLkyXksqVDXVA8uu73RRhv57AI9DARcQgYKWcaNG5eLnBoHV6yOejd79myfxgKwtEoYAG+22WbeA6PCnX766YVL9eVBfCnApVIKdYqnmMtNmsS8pJIoJwSoLEdSPa4oYXhgAE6bBQBg5O28Qp8s9yaLa5UCXDaKWJcuNpQXRkMGAKKxMke7s0yP8SHBm2+88caJWQBRwgAYJSzLeWQBSRGvURpw2XxO3vIVzoiGDBwhJ959//33M7MRWQDgRcrlTFhSg2cREgghyESUTQlrduNLBS5fpYQM/fr1q4QMUmhNkTnHyLPu5CgnEuRQI56/3gBgERLKpIQZuAk7gAJFLQAhg8S7Ai/ti2hrn4e3EyFBzoQ1qoSRsuMIEF3ULYT4v3FL5XFl2Ztssol/Xi51ARLvSuiA0oUwQZ43D1AAePDgwRUhIUkJ48NFXYUAnNe8mvV47X59KcElt4uMSkE3GYc4vJyU4IaJpzJy85bHAGCEBMnD1lLC5L0BeN68eZViGg5Baj1P1sh+lxJcNob0Ece5KWRBeYrDC7A8VvStt95KXW9QzxCihB199NFeSOBUcFQJ6+hvaSuKGphWxGgEkKK+prTgYhD52qYGAM+LV4sCzL/p+fXee+/50CHPBnKihAHwyJEj3QYbbNAhwMyFpibknvMIZYoKanxepQaXzQDYAQMG+LiTmFfglZ/AwZ0+WQfgRekC4LygAWDmA8C0/UfKFQ+MZMypjhkzZoTCV27zLD247CxgIAsTNvB0HKCNel/5NwCjTFEoQwaCh+mhuHUGYoGx1t/ygaIcUzwwCh8tpbQ+VLpZwg3cyI5xZJxj7XKnLw+4i/8EZIpmuIkDZADGC/M74JabJoESSAVU+RlV7+qBD8B9+vTx9Qdp2zQ1C0eRX2/gxqxDuAAoiBQUg0dDB/HE8Z/cyMX/A2BeJyDLv+Vv5ffRUssig1K0uRm4NSxCyECdAd6XkxQAJjBGweV30d9HgZX/Jz+BW4CV10UL3IsGR5HnY+DWsQ5f6zz9hhwrp24BWG7Wop6zI29aD+Ao+NGaiSKDUrS5GbgNWASAOclAvStxMHW93P1L7BuFtCOgo165I68tXreBqdhL/tsBA7dJFFDdgBh4iYHxwkAM3HKerRa8EgcLvHKD1uQU7OVkgmg5YDvR+R0AZMDlP/4dTXNJm8+4qNGZ9FnnZ6jzLw1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAg1cnXZVvyoDV72JdS7QwNVpV/WrMnDVm1jnAv8FdRSCpjQAIc4AAAAASUVORK5CYII=
contact:
name: X-Force API Support
email: [email protected]
x-categories:
- TI
- Threat intel
- Search
servers:
- url: https://api.xforce.ibmcloud.com
host: api.xforce.ibmcloud.com
basePath: /
schemes:
- "https:"
paths:
/auth/api_key:
post:
responses:
default:
description: default
schema: {}
summary: Returns an API key and password pair which are needed when accessingthe
API as an logged in user
description: |-
You can generate an API key and password in your XFE user
profile, or generate a new pair with this endpoint. The new
credentials are in the response object.
API keys and passwords do not expire. For example, the
following is usage of an API key/password with curl:
```
curl -u {apikey:password} https://api.xforce.ibmcloud.com/url/cnn.com
```
parameters: []
"/auth/api_key/{apikey}":
delete:
responses:
default:
description: default
schema: {}
summary: Revoke specific API Key
parameters:
- in: path
name: apikey
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/all-subscriptions/usage:
get:
responses:
default:
description: default
schema: {}
summary: Get API usage details per month for each subscription type
parameters: []
/app/:
get:
responses:
default:
description: default
schema: {}
summary: Returns list of all Internet Application Profiles IAP
parameters: []
/apps/fulltext:
get:
responses:
default:
description: default
schema: {}
summary: Returns list of all Internet Application Profiles IAP associated withthe
search term
parameters:
- in: query
name: q
description: Search term, For example, TestApp for Social Networking
required: true
schema:
type: string
"/app/{appname}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the Internet Application Profiles IAP that needs to befetched
parameters:
- in: path
name: appname
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{collectionID}":
get:
responses:
default:
description: default
schema: {}
summary: Returns a JSON resentation of a Collection
description: Returns details for a given Collection.
parameters:
- in: path
name: collectionID
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{collectionID}/stix":
get:
responses:
default:
description: default
schema: {}
summary: Returns a STIX representation of a Collection with Attachments
parameters:
- in: path
name: collectionID
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/casefiles/public:
get:
responses:
default:
description: default
schema: {}
summary: Gets all public Collections that you are able to see
description: >-
Returns a list of all publicly accessible Collections.
#### Curl Example:
```
curl -u {apikey:password} GET https://api.xforce.ibmcloud.com/casefiles/public
```
parameters: []
/casefiles/shared:
get:
responses:
default:
description: default
schema: {}
summary: Gets all shared Collections that you are able to see
description: Returns a list of all Collections that have been shared with you.
parameters: []
/casefiles:
get:
responses:
default:
description: default
schema: {}
summary: Gets all of your Collections
description: |-
This endpoint returns all the Collections that you have created, whether
they are shared or not.
parameters: []
"/casefiles/group/{groupID}":
get:
responses:
default:
description: default
schema: {}
summary: Returns a list of Collections for a given Group ID
description: This endpoint returns a list of Collections for a given Group ID.
parameters:
- in: path
name: groupID
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/casefiles/public/fulltext:
get:
responses:
default:
description: default
schema: {}
summary: Returns a list of public Collections that were found
description: This endpoint searches the title and wiki content of public Collections
and returns the result.
parameters:
- in: query
name: q
description: Search term, For example, Advisory
required: true
schema:
type: string
/casefiles/private/fulltext:
get:
responses:
default:
description: default
schema: {}
summary: Returns a list of private Collections that were found
description: This endpoint searches the title and wiki content of private collections
that were created by owner, shared with me, or shared with a group of
which I am a member and returns the result
parameters:
- in: query
name: q
description: Search term, For example, Advisory
required: true
schema:
type: string
"/casefiles/{casefileid}/upload":
post:
responses:
default:
description: default
schema: {}
summary: Endpoint to initiate the upload of a file
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{casefileid}/linkedcasefiles/{linkedcasefileid}":
delete:
responses:
default:
description: default
schema: {}
summary: Removes the linked Collection from the specified Collection
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: linkedcasefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{casefileid}/linkedcasefiles":
get:
responses:
default:
description: default
schema: {}
summary: Gets all linked Collections that you are able to see for the
specifiedCollection
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
put:
responses:
default:
description: default
schema: {}
summary: Adds a Collection link to a Collection
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{casefileid}/attachments":
get:
responses:
default:
description: default
schema: {}
summary: Get all attachments for a specified Collection
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{casefileid}/createreports":
post:
responses:
default:
description: default
schema: {}
summary: Endpoint to add reports to a casefile
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{casefileid}/attachments/{attachmentid}":
get:
responses:
default:
description: default
schema: {}
summary: Get an attachment for a specified Collection by ID
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: attachmentid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/casefiles/{casefileid}/attachments/{attachmentid}/{filename}":
get:
responses:
default:
description: default
schema: {}
summary: Get a file attachment for a specified Collection by ID
parameters:
- in: path
name: casefileid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: attachmentid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: filename
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/ipr:
get:
responses:
default:
description: default
schema: {}
summary: Return a list of IPs according to the category and date range
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: query
name: category
description: |-
categories for IPs, For example,
```
- Spam
- Anonymisation Services
- Scanning IPs
- Dynamic IPs
- Malware
- Bots
- Botnet Command and Control Server
```
required: true
schema:
type: string
- in: query
name: startDate
description: the start of the date range for searching, For example,
`2016-01-01T00:00:00Z`.
required: false
schema:
type: string
- in: query
name: endDate
description: the end of the date range for searching, For example,
`2016-01-01T00:00:00Z`. If not specified, the query will return the
newest IPs.
required: false
schema:
type: string
- in: query
name: descending
description: the order of returned IPs according to the created date and ips,
default value is true
required: false
schema:
type: string
- in: query
name: limit
description: the number of IPs to be returned. If not specified, the query will
return 200 IPs by default.
required: false
schema:
type: string
- in: query
name: skip
description: the number of IPs to be skipped while searching.
required: false
schema:
type: string
/industries:
get:
responses:
default:
description: default
schema: {}
summary: Return a list of Industry Analysis Reports
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: query
name: limit
description: the limit how many entries to retrieve, default value is 20
required: false
schema:
type: string
- in: query
name: offset
description: the startingpoint to retrieve entries, default value is 0
required: false
schema:
type: string
"/industries/{id}":
get:
responses:
default:
description: default
schema: {}
summary: Return a Industry Analysis Report
description: Full access to this information is restricted to paid users. Trial and
free users will have access to selected set of reports. Please visit
this link (https://exchange.xforce.ibmcloud.com/marketplace) for more
information.
parameters:
- in: path
name: id
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/malware_analysis:
get:
responses:
default:
description: default
schema: {}
summary: Return a list of Malware Analysis Reports
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: query
name: limit
description: the limit how many entries to retrieve, default value is 20
required: false
schema:
type: string
- in: query
name: offset
description: the startingpoint to retrieve entries, default value is 0
required: false
schema:
type: string
"/malware_analysis/{id}":
get:
responses:
default:
description: default
schema: {}
summary: Return a Malware Analysis Report
description: Full access to this information is restricted to paid users. Trial and
free users will have access to selected set of reports. Please visit
this link (https://exchange.xforce.ibmcloud.com/marketplace) for more
information.
parameters:
- in: path
name: id
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/threat_groups:
get:
responses:
default:
description: default
schema: {}
summary: Return a list of Threat Group Profiles
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: query
name: limit
description: the limit how many entries to retrieve, default value is 20
required: false
schema:
type: string
- in: query
name: offset
description: the startingpoint to retrieve entries, default value is 0
required: false
schema:
type: string
"/threat_groups/{id}":
get:
responses:
default:
description: default
schema: {}
summary: Return a Threat Group Profile
description: Full access to this information is restricted to paid users. Trial and
free users will have access to selected set of reports. Please visit
this link (https://exchange.xforce.ibmcloud.com/marketplace) for more
information.
parameters:
- in: path
name: id
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/stix/v2/export/{object}/{type}/{fullReport}":
get:
responses:
default:
description: default
schema: {}
summary: Return an Object in STIX format
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: path
name: type
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: object
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: fullReport
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/stix/v2/botnets:
get:
responses:
default:
description: default
schema: {}
summary: Return the full list of botnets in STIX format with their associated
Command and Control server details
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: query
name: fullReport
description: If set to true the DNS details are added to the returned data.
required: false
schema:
type: string
/hub/extensions:
get:
responses:
default:
description: default
schema: {}
summary: Gets all published Extensions in App Exchange
description: >-
Returns an object containing an array of all published extensions and
the size of the array.
#### Curl Example:
```
curl GET https://api.xforce.ibmcloud.com/hub/extensions
```
parameters: []
"/stix/v2/tis-export/{object}/{type}/false":
get:
responses:
default:
description: default
schema: {}
summary: Return a TIS Object Threat Group Industry or Malware report in STIX
format
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: path
name: type
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
- in: path
name: object
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/hub/extensions/brand/{brandnames}":
get:
responses:
default:
description: default
schema: {}
summary: Gets all published Extensions by brand names IBM Security Products
description: >-
Returns an object containing an array of all published extensions and
the size of the array.
#### Curl Example:
```
curl -u {apikey:password} GET https://api.xforce.ibmcloud.com/hub/extensions/brand/QRADAR_APP
```
parameters:
- in: path
name: brandnames
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/ipr/{ip}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the IP report for the entered IP
parameters:
- in: path
name: ip
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/ipr/history/{ip}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the IP reputation report for the entered IP
parameters:
- in: path
name: ip
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/ipr/malware/{ip}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the malware associated with the entered IP
parameters:
- in: path
name: ip
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/resolve/{input}":
get:
responses:
default:
description: default
schema: {}
summary: Returns live and passive DNS records
parameters:
- in: path
name: input
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/url/host/early_warning:
get:
responses:
default:
description: default
schema: {}
summary: Returns the list of domains in early warning feed
description: Access to this information is restricted to trial and enterprise users.
parameters:
- in: query
name: startDate
description: the start of the date range, for example, `2019-01-01T00:00:00Z`.
The default value is the beginning of the feed.
required: false
schema:
type: string
- in: query
name: endDate
description: the end of the date range, for example, `2019-01-01T00:00:00Z`. The
default value is now.
required: false
schema:
type: string
/url:
get:
responses:
default:
description: default
schema: {}
summary: Return a list of URLs according to the category and date range
description: Access to this information is restricted to trial and paid users. Please
visit this link (https://exchange.xforce.ibmcloud.com/marketplace) for
more information
parameters:
- in: query
name: category
description: |-
categories for URLs, For example,
```
- Illegal Activities
- Computer Crime / Hacking
- Warez / Software Piracy
- Violence / Extreme
- Spam URLs
- Malware
- Phishing URLs
- Botnet Command and Control Server
```
required: true
schema:
type: string
- in: query
name: startDate
description: the start of the date range for searching, For example,
`2016-01-01T00:00:00Z`.
required: false
schema:
type: string
- in: query
name: endDate
description: the end of the date range for searching, For example,
`2016-01-01T00:00:00Z`. If not specified, the query will return the
newest URLs.
required: false
schema:
type: string
- in: query
name: descending
description: the order of returned URLs according to the created date and URLs,
default value is true
required: false
schema:
type: string
- in: query
name: limit
description: the number of URLs to be returned. If not specified, the query will
return 200 URLs by default.
required: false
schema:
type: string
- in: query
name: skip
description: the number of URLs to be skipped while searching.
required: false
schema:
type: string
"/url/{url}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the URL report for the entered URL
parameters:
- in: path
name: url
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/url/history/{url}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the URL history for the entered URL
parameters:
- in: path
name: url
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/url/malware/{url}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the malware associated with the entered URL
parameters:
- in: path
name: url
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/malware/{filehash}":
get:
responses:
default:
description: default
schema: {}
summary: Returns a malware report for the given file hash For example md5 sha1
and sha256
parameters:
- in: path
name: filehash
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/malware/family/{family}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the malware associated with the entered family
parameters:
- in: path
name: family
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/malware/familyext/{family}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the malware associated with the entered family using wildcard
search
parameters:
- in: path
name: family
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
/vulnerabilities/:
get:
responses:
default:
description: default
schema: {}
summary: Returns recent vulnerabilities
parameters:
- in: query
name: startDate
description: the start of the date range for searching, For example,
`2016-01-01T00:00:00Z`.
required: false
schema:
type: string
- in: query
name: endDate
description: the end of the date range for searching, For example,
`2016-01-01T00:00:00Z`. If not specified, the query will return the
newest vulnerabilities.
required: false
schema:
type: string
- in: query
name: descending
description: the order of returned Vulnerabilities according to the reported
date, default value is true
required: false
schema:
type: string
- in: query
name: limit
description: number of vulnerabilities
required: false
schema:
type: string
- in: query
name: skip
description: the number of Vulnerabilities to be skipped while searching.
required: false
schema:
type: string
/vulnerabilities/fulltext:
get:
responses:
default:
description: default
schema: {}
summary: Returns list of all vulnerabilities associated with the search term
parameters:
- in: query
name: q
description: Search term For example, Heartbleed. For searching based on affected
platforms, place the index "platforms_affected" before search term,
For example, platforms_affected:"IBM Security Network Protection"
required: true
schema:
type: string
- in: query
name: startDate
description: the start of the date range for searching, For example,
`2016-01-01T00:00:00Z`.
required: false
schema:
type: string
- in: query
name: endDate
description: the end of the date range for searching, For example,
`2016-01-01T00:00:00Z`. If not specified, the query will return the
newest vulnerabilities.
required: false
schema:
type: string
- in: query
name: bookmark
description: Bookmark used to page through results.
required: false
schema:
type: string
"/vulnerabilities/{xfid}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the vulnerability associated with the entered xfdbid
parameters:
- in: path
name: xfid
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/vulnerabilities/search/{stdcode}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the vulnerability associated with the entered stdcode
description: Supported codes are CVE, BID, US-CERT VU# and RHSA.
parameters:
- in: path
name: stdcode
description: Generated by shuffler.io OpenAPI
required: true
schema:
type: string
"/vulnerabilities/msid/{msid}":
get:
responses:
default:
description: default
schema: {}
summary: Returns the vulnerability associated with the entered Microsoft Security
Bulletin ID
parameters:
- in: path
name: msid
description: Generated by shuffler.io OpenAPI
required: true
schema: