forked from demisto/demisto-py
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server_api_swagger.json
8125 lines (8125 loc) · 223 KB
/
server_api_swagger.json
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
{
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"description": "This is the public REST API to integrate with the demisto server.\nHTTP request can be sent using any HTTP-client.\n\nFor an example dedicated client take a look at: https://github.com/demisto/demisto-py.\n\nRequests must include API-key that can be generated in the Demisto web client under 'Settings' -\u003e 'Integrations' -\u003e 'API keys'\n\n\nOptimistic Locking and Versioning\\:\n\nWhen using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item).\nIn addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost).\n\nAssume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s?\nTo solve this, each data item in Demisto has a numeric incremental version.\nIf Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error.\nBob will need to get the latest item and work on it so Alice work will not get lost.\n\nExample request using 'curl'\\:\n\n```\ncurl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: \u003cAPI Key goes here\u003e' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed\n```",
"title": "Demisto API",
"version": "2.0.0"
},
"host": "hostname:443",
"paths": {
"/apikeys/revoke/user/{username}": {
"post": {
"description": "Revoke API Key for user",
"produces": [
"application/octet-stream"
],
"operationId": "revokeUserAPIKey",
"parameters": [
{
"type": "string",
"description": "The username which the API keys assigned to",
"name": "username",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "200 for success"
}
}
}
},
"/automation": {
"post": {
"description": "Create or update a given automation.",
"summary": "Create or update automation",
"operationId": "saveOrUpdateScript",
"parameters": [
{
"name": "automationScriptFilterWrapper",
"in": "body",
"schema": {
"$ref": "#/definitions/automationScriptFilterWrapper"
}
}
],
"responses": {
"200": {
"description": "The saved automation.",
"schema": {
"$ref": "#/definitions/automationScriptResult"
}
}
}
}
},
"/automation/copy": {
"post": {
"description": "Copy given automation",
"summary": "Copy automation",
"operationId": "copyScript",
"parameters": [
{
"name": "automationScriptFilterWrapper",
"in": "body",
"schema": {
"$ref": "#/definitions/automationScriptFilterWrapper"
}
}
],
"responses": {
"200": {
"description": "The saved automation.",
"schema": {
"$ref": "#/definitions/automationScriptResult"
}
}
}
}
},
"/automation/delete": {
"post": {
"description": "Delete a given automation from the system.",
"summary": "Delete existing automation",
"operationId": "deleteAutomationScript",
"parameters": [
{
"name": "automationScriptFilterWrapper",
"in": "body",
"schema": {
"$ref": "#/definitions/automationScriptFilterWrapper"
}
}
],
"responses": {
"200": {
"description": "automation deleted"
}
}
}
},
"/automation/search": {
"post": {
"description": "Search Automation by filter",
"summary": "Search Automation (aka scripts)",
"operationId": "getAutomationScripts",
"parameters": [
{
"name": "automationScriptFilter",
"in": "body",
"schema": {
"$ref": "#/definitions/automationScriptFilter"
}
}
],
"responses": {
"200": {
"description": "automationScriptResult",
"schema": {
"$ref": "#/definitions/automationScriptResult"
}
}
}
}
},
"/entry": {
"post": {
"description": "API to create an entry (markdown format) in existing investigation\nBody example: {\"investigationId\":\"1234\",\"data\":\"entry content…\"}",
"summary": "Create new entry in existing investigation",
"operationId": "investigationAddEntryHandler",
"parameters": [
{
"name": "updateEntry",
"in": "body",
"schema": {
"$ref": "#/definitions/updateEntry"
}
}
],
"responses": {
"200": {
"description": "Entry",
"schema": {
"$ref": "#/definitions/Entry"
}
},
"412": {
"description": "In case of closed investigation"
}
}
}
},
"/entry/artifact/{id}": {
"get": {
"description": "Get the entry artifact file",
"produces": [
"application/octet-stream"
],
"summary": "Get entry artifact",
"operationId": "getEntryArtifact",
"parameters": [
{
"type": "string",
"description": "file to fetch (returned from entry export artifact call)",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Return the file",
"schema": {
"type": "file"
}
}
}
}
},
"/entry/exportArtifact": {
"post": {
"description": "Export an entry artifact",
"summary": "Export Artifact",
"operationId": "entryExportArtifact",
"parameters": [
{
"name": "DownloadEntry",
"in": "body",
"schema": {
"$ref": "#/definitions/DownloadEntry"
}
}
],
"responses": {
"200": {
"description": "created file name",
"schema": {
"type": "string"
}
}
}
}
},
"/entry/formatted": {
"post": {
"description": "API to create a formatted entry (table/json/text/markdown/html) in existing investigation\nBody example: {\"investigationId\":\"1234\",\"format\":\"table/json/text/markdown/html\",\"contents\":\"entry content…\"}",
"summary": "Create new formatted entry in existing investigation",
"operationId": "investigationAddFormattedEntryHandler",
"parameters": [
{
"name": "uploadedEntry",
"in": "body",
"schema": {
"$ref": "#/definitions/uploadedEntry"
}
}
],
"responses": {
"200": {
"description": "Entry",
"schema": {
"$ref": "#/definitions/Entry"
}
}
}
}
},
"/entry/note": {
"post": {
"description": "API to mark entry as note, can be used also to remove the note\nBody example: {\"id\":1\\@1234\",\"version\":\"-1\",\"investigationId\":\"1234\",\"data\":\"true/false\"}",
"summary": "Mark entry as note",
"operationId": "updateEntryNote",
"parameters": [
{
"name": "updateEntry",
"in": "body",
"schema": {
"$ref": "#/definitions/updateEntry"
}
}
],
"responses": {
"200": {
"description": "Entry",
"schema": {
"$ref": "#/definitions/Entry"
}
}
}
}
},
"/entry/tags": {
"post": {
"description": "API to set entry tags\nBody example: {\"id\":\"1\\@1234\",\"version\":\"-1\",\"investigationId\":\"1234\",\"tags\":[\"tag1\",\"tag2\"]\"}",
"summary": "Set entry tags",
"operationId": "updateEntryTagsOp",
"parameters": [
{
"name": "updateEntryTags",
"in": "body",
"schema": {
"$ref": "#/definitions/updateEntryTags"
}
}
],
"responses": {
"200": {
"description": "Entry",
"schema": {
"$ref": "#/definitions/Entry"
}
}
}
}
},
"/evidence": {
"post": {
"description": "Save an evidence entity\nTo update evidence custom fields you should lowercase them and remove all spaces. For example: Scan IP -\u003e scanip",
"summary": "Save evidence",
"operationId": "saveEvidence",
"parameters": [
{
"name": "Evidence",
"in": "body",
"schema": {
"$ref": "#/definitions/Evidence"
}
}
],
"responses": {
"200": {
"description": "The new / updated Evidence",
"schema": {
"$ref": "#/definitions/Evidence"
}
}
}
}
},
"/evidence/delete": {
"post": {
"description": "Delete an evidence entity",
"summary": "delete evidence",
"operationId": "deleteEvidenceOp",
"parameters": [
{
"name": "deleteEvidence id",
"in": "body",
"schema": {
"$ref": "#/definitions/deleteEvidence"
}
}
],
"responses": {
"200": {
"description": "Deleted evidence ID"
}
}
}
},
"/evidence/search": {
"post": {
"description": "Search for an evidence entutiy by filter",
"summary": "Search evidence",
"operationId": "searchEvidence",
"parameters": [
{
"name": "evidencesFilterWrapper",
"in": "body",
"schema": {
"$ref": "#/definitions/evidencesFilterWrapper"
}
}
],
"responses": {
"200": {
"description": "EvidencesSearchResponse",
"schema": {
"$ref": "#/definitions/EvidencesSearchResponse"
}
}
}
}
},
"/incident": {
"post": {
"description": "Create or update incident according to JSON structure.\nTo update incident custom fields you should lowercase them and remove all spaces. For example: Scan IP -\u003e scanip\nTo get the actual key name you can also go to Demisto CLI and run /incident_add and look for the key that you would like to update\n\nUse the 'createInvestigation\\: True' to start the investigation process automatically. (by running a playbook based on incident type.)",
"summary": "Create single incident",
"operationId": "createIncident",
"parameters": [
{
"name": "CreateIncidentRequest",
"in": "body",
"schema": {
"$ref": "#/definitions/CreateIncidentRequest"
}
}
],
"responses": {
"200": {
"description": "IncidentWrapper",
"schema": {
"$ref": "#/definitions/IncidentWrapper"
}
}
}
}
},
"/incident/batch": {
"post": {
"description": "Create or update an incidents batch\nTo update incident custom fields you should lowercase them and remove all spaces. For example: Scan IP -\u003e scanip\nTo get the actual key name you can also go to Demisto CLI and run /incident_add and look for the key that you would like to update",
"summary": "Batch create incidents",
"operationId": "createIncidentsBatch",
"parameters": [
{
"name": "UpdateDataBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/UpdateDataBatch"
}
}
],
"responses": {
"200": {
"description": "IncidentSearchResponseWrapper",
"schema": {
"$ref": "#/definitions/IncidentSearchResponseWrapper"
}
}
}
}
},
"/incident/batch/exportToCsv": {
"post": {
"description": "Exports an incidents batch to CSV file (returns file ID)",
"summary": "Batch export incidents to csv",
"operationId": "exportIncidentsToCsvBatch",
"parameters": [
{
"name": "UpdateDataBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/UpdateDataBatch"
}
}
],
"responses": {
"200": {
"description": "csv file name",
"schema": {
"type": "string"
}
}
}
}
},
"/incident/batchClose": {
"post": {
"description": "Closes an incidents batch\nTo update incident custom fields you should lowercase them and remove all spaces. For example: Scan IP -\u003e scanip\nTo get the actual key name you can also go to Demisto CLI and run /incident_add and look for the key that you would like to update",
"summary": "Batch close incidents",
"operationId": "closeIncidentsBatch",
"parameters": [
{
"name": "UpdateDataBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/UpdateDataBatch"
}
}
],
"responses": {
"200": {
"description": "IncidentSearchResponseWrapper",
"schema": {
"$ref": "#/definitions/IncidentSearchResponseWrapper"
}
}
}
}
},
"/incident/batchDelete": {
"post": {
"description": "Deletes an incidents batch",
"summary": "Batch delete incidents",
"operationId": "deleteIncidentsBatch",
"parameters": [
{
"name": "UpdateDataBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/UpdateDataBatch"
}
}
],
"responses": {
"200": {
"description": "IncidentSearchResponseWrapper",
"schema": {
"$ref": "#/definitions/IncidentSearchResponseWrapper"
}
}
}
}
},
"/incident/csv/{id}": {
"get": {
"description": "Get an incident CSV file that was exported, by ID",
"produces": [
"application/octet-stream"
],
"summary": "Get incident as CSV",
"operationId": "getIncidentAsCsv",
"parameters": [
{
"type": "string",
"description": "CSV file to fetch (returned from batch export to csv call)",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Return Csv file",
"schema": {
"type": "file"
}
}
}
}
},
"/incident/json": {
"post": {
"description": "Create single incident from raw JSON, builds incident according to default mapping",
"summary": "Create incident from JSON",
"operationId": "createIncidentJson",
"responses": {
"200": {
"description": "IncidentWrapper",
"schema": {
"$ref": "#/definitions/IncidentWrapper"
}
}
}
}
},
"/incident/upload/{id}": {
"post": {
"description": "Add file attachement to an incidents",
"consumes": [
"multipart/form-data"
],
"operationId": "incidentFileUpload",
"parameters": [
{
"type": "string",
"description": "Incident id to update",
"name": "id",
"in": "path"
},
{
"type": "string",
"description": "file name",
"name": "fileName",
"in": "formData"
},
{
"type": "string",
"description": "file comment",
"name": "fileComment",
"in": "formData"
},
{
"type": "string",
"description": "field name to hold the attachment details. If not specified, `attachment` will be used.",
"name": "field",
"in": "formData"
},
{
"type": "boolean",
"description": "show media file",
"name": "showMediaFile",
"in": "formData"
},
{
"type": "boolean",
"description": "If set to true will create an investigation. Used for uploading after creating incident.",
"name": "last",
"in": "formData"
},
{
"type": "file",
"description": "file",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "IncidentWrapper",
"schema": {
"$ref": "#/definitions/IncidentWrapper"
}
}
}
}
},
"/incidentfields/associatedTypes/{type}": {
"get": {
"description": "Get all incident fields associated with incident type",
"summary": "Get all incident fields associated with incident type",
"operationId": "getIncidentsFieldsByIncidentType",
"parameters": [
{
"type": "string",
"description": "the name (case sensitive) of the incident type",
"name": "type",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Returns a list of incident fields associated with the incident type",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IncidentField"
}
}
}
}
}
},
"/incidents/search": {
"post": {
"description": "This will search incidents across all indices\nYou can filter by multiple options",
"summary": "Search incidents by filter",
"operationId": "searchIncidents",
"parameters": [
{
"name": "filter",
"in": "body",
"schema": {
"$ref": "#/definitions/SearchIncidentsData"
}
}
],
"responses": {
"200": {
"description": "incidentSearchResponse",
"schema": {
"type": "object",
"properties": {
"incidents": {
"type": "array",
"items": {
"$ref": "#/definitions/Incident"
}
},
"total": {
"type": "integer"
}
}
}
}
}
}
},
"/incidenttype": {
"post": {
"description": "API to create new Incident Type",
"summary": "Create new Incident Type",
"operationId": "createOrUpdateIncidentType",
"parameters": [
{
"name": "IncidentType",
"in": "body",
"schema": {
"$ref": "#/definitions/IncidentType"
}
}
],
"responses": {
"200": {
"description": "IncidentType",
"schema": {
"$ref": "#/definitions/IncidentType"
}
}
}
}
},
"/indicator/create": {
"post": {
"description": "Create an indicator entity\nTo update indicator custom fields you should lowercase them and remove all spaces. For example: Scan IP -\u003e scanip",
"summary": "Create Indicator",
"operationId": "indicatorsCreate",
"parameters": [
{
"name": "IocObject",
"in": "body",
"schema": {
"$ref": "#/definitions/indicatorContext"
}
}
],
"responses": {
"200": {
"description": "IocObject",
"schema": {
"$ref": "#/definitions/IocObject"
}
}
}
}
},
"/indicator/edit": {
"post": {
"description": "Edit an indicator entity\nTo update indicator custom fields you should lowercase them and remove all spaces. For example: Scan IP -\u003e scanip",
"summary": "Edit Indicator",
"operationId": "indicatorsEdit",
"parameters": [
{
"name": "IocObject",
"in": "body",
"schema": {
"$ref": "#/definitions/IocObject"
}
}
],
"responses": {
"200": {
"description": "IocObject",
"schema": {
"$ref": "#/definitions/IocObject"
}
}
}
}
},
"/indicator/whitelist": {
"post": {
"description": "Whitelists or deletes an indicator entity\nIn order to delete an indicator and not whitelist, set doNotWhitelist boolean field to true",
"summary": "Whitelists or deletes Indicator",
"operationId": "indicatorWhitelist",
"parameters": [
{
"name": "updateIndicatorReputationData",
"in": "body",
"schema": {
"$ref": "#/definitions/updateIndicatorReputationData"
}
}
],
"responses": {
"200": {
"description": "UpdateResponse",
"schema": {
"$ref": "#/definitions/UpdateResponse"
}
}
}
}
},
"/indicators/batch/export/stix": {
"post": {
"description": "Exports an indicators batch to STIX file (returns file ID)",
"summary": "Batch export indicators to STIX",
"operationId": "exportIndicatorsToStixBatch",
"parameters": [
{
"name": "genericIndicatorUpdateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/genericIndicatorUpdateBatch"
}
}
],
"responses": {
"200": {
"description": "STIX file name",
"schema": {
"type": "string"
}
}
}
}
},
"/indicators/batch/exportToCsv": {
"post": {
"description": "Exports an indicators batch to CSV file (returns file ID)",
"summary": "Batch export indicators to csv",
"operationId": "exportIndicatorsToCsvBatch",
"parameters": [
{
"description": "Required parameters from `genericIndicatorUpdateBatch`: `columns`,\n`filter`. You should also include either `all` or `ids`\n",
"name": "genericIndicatorUpdateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/genericIndicatorUpdateBatch"
}
}
],
"responses": {
"200": {
"description": "csv file name",
"schema": {
"type": "string"
}
}
}
}
},
"/indicators/batchDelete": {
"post": {
"description": "Batch whitelist or delete indicators entities\nIn order to delete indicators and not whitelist, set doNotWhitelist boolean field to true",
"summary": "Batch whitelist or delete indicators",
"operationId": "deleteIndicatorsBatch",
"parameters": [
{
"name": "genericIndicatorUpdateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/genericIndicatorUpdateBatch"
}
}
],
"responses": {
"200": {
"description": "UpdateResponse",
"schema": {
"$ref": "#/definitions/UpdateResponse"
}
}
}
}
},
"/indicators/csv/{id}": {
"get": {
"description": "Get an indicators CSV file that was exported, by ID",
"produces": [
"application/octet-stream"
],
"summary": "Get indicators as CSV",
"operationId": "getIndicatorsAsCsv",
"parameters": [
{
"type": "string",
"description": "CSV file to fetch (returned from batch export to csv call)",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Return Csv file",
"schema": {
"type": "file"
}
}
}
}
},
"/indicators/search": {
"post": {
"description": "Search indicators by filter",
"summary": "Search indicators",
"operationId": "indicatorsSearch",
"parameters": [
{
"name": "IndicatorFilter",
"in": "body",
"schema": {
"$ref": "#/definitions/IndicatorFilter"
}
}
],
"responses": {
"200": {
"description": "indicatorResult",
"schema": {
"$ref": "#/definitions/IndicatorResult"
}
}
}
}
},
"/indicators/stix/v2/{id}": {
"get": {
"description": "Get an indicators STIX V2 file that was exported, by ID",
"produces": [
"application/octet-stream"
],
"summary": "Get indicators as STIX V2",
"operationId": "getIndicatorsAsSTIX",
"parameters": [
{
"type": "string",
"description": "STIX V2 file to fetch (returned from batch export to STIX call)",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Return STIX V2 file",
"schema": {
"type": "file"
}
}
}
}
},
"/indicators/upload": {
"post": {
"description": "Create indicators from a file",
"consumes": [
"multipart/form-data"
],
"summary": "Create indicators",
"operationId": "indicatorsCreateBatch",
"parameters": [
{
"type": "string",
"description": "file name",
"name": "fileName",
"in": "formData"
},
{
"type": "file",
"description": "file",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "IocObjects",
"schema": {
"$ref": "#/definitions/IocObjects"
}
}
}
}
},
"/inv-playbook/task/add/{investigationId}": {
"post": {
"description": "Add an ad-hoc task to a running playbook",
"summary": "Add ad-hoc task",
"operationId": "addAdHocTask",
"parameters": [
{
"name": "InvPlaybookTaskData",
"in": "body",
"schema": {
"$ref": "#/definitions/InvPlaybookTaskData"
}
},
{
"type": "string",
"description": "investigation ID",
"name": "investigationId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "InvestigationPlaybook",
"schema": {
"$ref": "#/definitions/InvestigationPlaybook"
}
}
}
}
},
"/inv-playbook/task/assign": {
"post": {
"description": "Assign a task to an owner",
"summary": "Assign task",
"operationId": "taskAssign",
"parameters": [
{
"name": "invPlaybookAssignee",
"in": "body",
"schema": {
"$ref": "#/definitions/invPlaybookAssignee"
}
}
],
"responses": {
"200": {
"description": "InvestigationPlaybook",
"schema": {
"$ref": "#/definitions/InvestigationPlaybook"
}
}
}
}
},
"/inv-playbook/task/complete": {
"post": {
"description": "Complete a task with a file attachment\nDeprecated - use \"/v2/inv-playbook/task/complete\"",
"consumes": [
"multipart/form-data"
],
"summary": "[Deprecated] Complete a task",
"operationId": "completeTask",
"parameters": [
{
"type": "string",
"description": "investigation ID",
"name": "investigationId",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "file name",
"name": "fileName",
"in": "formData"
},
{
"type": "string",
"description": "file comment",