-
Notifications
You must be signed in to change notification settings - Fork 0
/
tc_indicators.yaml
2511 lines (2511 loc) · 58.1 KB
/
tc_indicators.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.1
info:
title: ThreatConnect API
description: This is Threatconnect's V3 API documentation
termsOfService: http://swagger.io/terms/
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: '3.0'
servers:
- url: https://app.threatconnect.com/api
description: ''
security:
- APIKeyAuth: []
paths:
/v3/indicators/{uniqueId}:
get:
tags:
- Indicators
summary: Retrieve Indicator by ID
description: Returns a single Indicator corresponding to provided uniqueId
operationId: retrieveIndicatorById
parameters:
- name: uniqueId
in: path
description: ID of the Indicator to be fetched
required: true
schema:
type: string
description: param ID of the Indicator that needs to be fetched
enum:
- '1'
- '2'
- '3'
- name: fields
in: query
description: >-
Indicator subentity fields to include in response (See OPTIONS
endpoint for valid values)
schema:
type: array
items:
type: string
- name: count
in: query
description: >-
Boolean that detnotes whether counts should be returned in the
resultset
schema:
type: string
responses:
'200':
description: The Indicator
content:
application/json:
schema:
$ref: '#/components/schemas/Indicator'
put:
tags:
- Indicators
summary: Update Indicator by ID
description: Allows the updating of an existing Indicator
operationId: updateIndicatorById
parameters:
- name: uniqueId
in: path
description: ID of the Indicator to be updated
required: true
schema:
type: string
description: param ID of the Indicator that needs to be updated
enum:
- '1'
- '2'
- '3'
- name: fields
in: query
description: >-
Indicator subentity fields to include in response (See OPTIONS
endpoint for valid values)
schema:
type: array
items:
type: string
- name: createActivityLog
in: query
description: Boolean to signal whether or not to create an alert for this action
schema:
type: string
default: ''
requestBody:
description: The Indicator object to be updated
content:
application/json:
schema:
$ref: '#/components/schemas/Indicator'
required: true
responses:
'200':
description: The updated Indicator
content:
application/json:
schema:
$ref: '#/components/schemas/Indicator'
delete:
tags:
- Indicators
summary: Delete Indicator by ID
description: Allows the deletion of an existing Indicator
operationId: deleteIndicatorById
parameters:
- name: uniqueId
in: path
description: ID of entity to be deleted
required: true
schema:
type: string
description: param ID of the Indicator that needs to be deleted
enum:
- '1'
- '2'
- '3'
- name: createActivityLog
in: query
description: Boolean to signal whether or not to create an alert for this action
schema:
type: string
default: ''
responses:
'200':
description: Indicator deleted successfully
/v3/indicators:
get:
tags:
- Indicators
summary: Retrieve Indicators
description: Returns a list of all Indicators
operationId: retrieveIndicators
parameters:
- name: tql
in: query
description: 'TQL query string for filtering response list '
schema:
type: string
default: ''
- name: fields
in: query
description: >-
Indicator subentity fields to include in response (See OPTIONS
endpoint for valid values)
schema:
type: array
items:
type: string
- name: count
in: query
description: >-
Boolean that detnotes whether counts should be returned in the
resultset
schema:
type: string
- name: sorting
in: query
description: Sorting order for resultset
schema:
type: string
responses:
'200':
description: The Indicators
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Indicator'
post:
tags:
- Indicators
summary: Create Indicator
description: Allows the creation of a new Indicator
operationId: createIndicator
parameters:
- name: fields
in: query
description: >-
Indicator subentity fields to include in response (See OPTIONS
endpoint for valid values)
schema:
type: array
items:
type: string
- name: createActivityLog
in: query
description: Boolean to signal whether or not to create an alert for this action
schema:
type: string
default: ''
requestBody:
description: New Indicator object to be created
content:
application/json:
schema:
$ref: '#/components/schemas/Indicator'
required: true
responses:
'200':
description: The new Indicator
content:
application/json:
schema:
$ref: '#/components/schemas/Indicator'
options:
tags:
- Indicators
summary: Retrieve entity info
description: Returns information about the entity fields
operationId: getObjectInfo_16
parameters:
- name: show
in: query
description: Read only filter for results
schema:
type: string
default: ''
responses:
'200':
description: The entity information
/v3/indicators/deleted:
get:
tags:
- Indicators
summary: Retrieve Deleted Indicators
description: Returns a list of deleted Indicators
operationId: retrieveDeletedIndicators
parameters:
- name: type
in: query
description: A type value for limiting results to provided type
schema:
type: string
- name: deletedSince
in: query
description: >-
A date for limiting the query results. Will return indicators
deleted after date provided
schema:
type: string
- name: resultStart
in: query
schema:
type: string
- name: resultLimit
in: query
schema:
type: string
responses:
'200':
description: The Indicators
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Indicator'
/v3/indicators/{uniqueId}/enrich:
post:
tags:
- Indicators
summary: Enrich Indicator
description: Enriches the selected indicator with 3rd-Party information
operationId: enrichSingleIndicator
parameters:
- name: uniqueId
in: path
required: true
schema:
type: string
- name: type
in: query
schema:
type: array
items:
type: string
- name: count
in: query
schema:
type: string
- name: fields
in: query
schema:
type: array
items:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryApiEntity'
responses:
'200':
description: The Indicator
content:
application/json:
schema:
$ref: '#/components/schemas/Indicator'
/v3/indicators/enrich:
post:
tags:
- Indicators
summary: Enrich Indicators
description: Enriches a list of Indicators with 3rd-Party information
operationId: enrichMultipleIndicators
parameters:
- name: type
in: query
schema:
type: array
items:
type: string
responses:
'200':
description: Count of indicators enriched
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Indicator'
/v3/indicators/fields:
options:
tags:
- Indicators
summary: Retrieve fields
description: Returns a list of valid field options
operationId: getIncludeInfo_16
responses:
'200':
description: The field options
/v3/indicators/tql:
options:
tags:
- Indicators
summary: Retrieve tql
description: Returns a list of valid tql options
operationId: getTqlInfo_16
parameters:
- name: show
in: query
description: Read only filter for results
schema:
type: string
default: ''
responses:
'200':
description: The tql options
components:
schemas:
AbstractEnrichment:
type: object
properties:
type:
type: string
AdversaryAsset:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
type:
type: string
webLink:
type: string
phoneNumber:
type: string
handle:
type: string
url:
type: string
Artifact:
required:
- caseId
- caseXid
- summary
- type
type: object
properties:
id:
type: integer
format: int64
caseId:
type: integer
format: int64
caseXid:
type: string
summary:
maxLength: 500
minLength: 1
type: string
type:
type: string
fieldName:
maxLength: 100
minLength: 0
type: string
artifactType:
$ref: '#/components/schemas/ArtifactType'
intelType:
type: string
fileData:
type: string
source:
maxLength: 100
minLength: 0
type: string
dateAdded:
type: string
format: date-time
analyticsType:
type: string
analyticsScore:
type: integer
format: int32
analyticsPriority:
type: string
analyticsPriorityLevel:
type: integer
format: int32
analyticsStatus:
type: string
taskId:
type: integer
format: int64
taskXid:
type: string
notes:
$ref: '#/components/schemas/ListEntityNote'
links:
$ref: '#/components/schemas/ListEntityLink'
associatedGroups:
$ref: '#/components/schemas/ListEntityGroup'
associatedIndicators:
$ref: '#/components/schemas/ListEntityIndicator'
derivedLink:
type: boolean
hashCode:
type: string
ArtifactType:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
description:
type: string
dataType:
type: string
intelType:
type: string
derivedLink:
type: boolean
Assignee:
required:
- type
type: object
properties:
id:
type: integer
format: int64
type:
type: string
AttackSecurityCoverage:
type: object
properties:
id:
type: integer
format: int64
value:
maxLength: 10
minLength: 0
type: string
AttributeData:
required:
- value
type: object
properties:
id:
type: integer
format: int64
dateAdded:
type: string
format: date-time
securityLabels:
$ref: '#/components/schemas/ListEntitySecurityLabel'
type:
type: string
value:
maxLength: 2147483647
minLength: 1
type: string
source:
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModified:
type: string
format: date-time
settings:
$ref: '#/components/schemas/AttributeSettings'
pinned:
type: boolean
default:
type: boolean
AttributeSettings:
type: object
properties:
id:
type: integer
format: int64
owner:
type: string
associable:
type: boolean
pinnedByDefault:
type: boolean
message:
maxLength: 400
minLength: 1
type: string
Case:
required:
- name
- severity
- status
type: object
properties:
id:
type: integer
format: int64
xid:
maxLength: 100
minLength: 10
type: string
name:
maxLength: 255
minLength: 1
type: string
description:
maxLength: 1500
minLength: 0
type: string
dateAdded:
type: string
format: date-time
lastUpdated:
type: string
format: date-time
caseOpenTime:
type: string
format: date-time
caseCloseTime:
type: string
format: date-time
caseOpenUser:
$ref: '#/components/schemas/User'
caseCloseUser:
$ref: '#/components/schemas/User'
caseOccurrenceTime:
type: string
format: date-time
caseOccurrenceUser:
$ref: '#/components/schemas/User'
caseDetectionTime:
type: string
format: date-time
caseDetectionUser:
$ref: '#/components/schemas/User'
status:
type: string
severity:
type: string
resolution:
type: string
assignee:
$ref: '#/components/schemas/Assignee'
tasks:
$ref: '#/components/schemas/ListEntityTask'
artifacts:
$ref: '#/components/schemas/ListEntityArtifact'
tags:
$ref: '#/components/schemas/ListEntityTag'
notes:
$ref: '#/components/schemas/ListEntityNote'
workflowEvents:
$ref: '#/components/schemas/ListEntityWorkflowEvent'
userAccess:
$ref: '#/components/schemas/ListEntityUser'
createdBy:
$ref: '#/components/schemas/User'
owner:
type: string
ownerId:
type: integer
format: int64
workflowTemplate:
$ref: '#/components/schemas/WorkflowTemplate'
related:
$ref: '#/components/schemas/ListEntityCase'
relationship:
type: string
attributes:
$ref: '#/components/schemas/ListEntityCaseAttributeData'
associatedGroups:
$ref: '#/components/schemas/ListEntityGroup'
associatedIndicators:
$ref: '#/components/schemas/ListEntityIndicator'
associatedCases:
$ref: '#/components/schemas/ListEntityCase'
CaseAttributeData:
required:
- caseId
- value
type: object
properties:
id:
type: integer
format: int64
dateAdded:
type: string
format: date-time
securityLabels:
$ref: '#/components/schemas/ListEntitySecurityLabel'
type:
type: string
value:
maxLength: 2147483647
minLength: 1
type: string
source:
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModified:
type: string
format: date-time
settings:
$ref: '#/components/schemas/AttributeSettings'
caseId:
type: integer
format: int64
pinned:
type: boolean
default:
type: boolean
Contact:
type: object
properties:
id:
type: integer
format: int64
type:
maxLength: 45
minLength: 0
type: string
name:
maxLength: 150
minLength: 0
type: string
organization:
maxLength: 150
minLength: 0
type: string
street1:
maxLength: 150
minLength: 0
type: string
street2:
maxLength: 150
minLength: 0
type: string
city:
maxLength: 150
minLength: 0
type: string
state:
maxLength: 150
minLength: 0
type: string
postalCode:
maxLength: 15
minLength: 0
type: string
country:
maxLength: 45
minLength: 0
type: string
phone:
maxLength: 100
minLength: 0
type: string
email:
maxLength: 255
minLength: 0
type: string
DNSResolution:
type: object
properties:
id:
type: integer
format: int64
addresses:
$ref: '#/components/schemas/ListEntityIndicator'
host:
$ref: '#/components/schemas/Indicator'
dateOccurred:
type: string
format: date-time
FileAction:
type: object
properties:
relationship:
type: string
indicator:
$ref: '#/components/schemas/Indicator'
FileOccurrence:
required:
- fileName
- path
type: object
properties:
id:
type: integer
format: int64
fileName:
maxLength: 255
minLength: 0
type: string
path:
maxLength: 255
minLength: 0
type: string
date:
type: string
format: date-time
GeoLocation:
type: object
properties:
id:
type: integer
format: int64
country:
maxLength: 55
minLength: 0
type: string
countryCode:
maxLength: 2
minLength: 0
type: string
state:
maxLength: 255
minLength: 0
type: string
timezone:
type: string
city:
maxLength: 255
minLength: 0
type: string
asn:
type: integer
format: int32
registeringOrg:
maxLength: 255
minLength: 0
type: string
lat:
type: number
format: double
lon:
type: number
format: double
Group:
required:
- name
- type
type: object
properties:
id:
type: integer
format: int64
dateAdded:
type: string
format: date-time
securityLabels:
$ref: '#/components/schemas/ListEntitySecurityLabel'
ownerId:
type: integer
format: int64
ownerName:
type: string
webLink:
type: string
tags:
$ref: '#/components/schemas/ListEntityTag'
type:
maxLength: 2147483647
minLength: 1
type: string
xid:
type: string
name:
maxLength: 100
minLength: 0
type: string
createdBy:
$ref: '#/components/schemas/User'
upVote:
type: boolean
upVoteCount:
type: string
downVoteCount:
type: string
generatedReport:
type: boolean
associatedGroups:
$ref: '#/components/schemas/ListEntityGroup'
associatedIndicators:
$ref: '#/components/schemas/ListEntityIndicator'
associatedVictimAssets:
$ref: '#/components/schemas/ListEntityVictimAsset'
externalDateAdded:
type: string
format: date-time
externalLastModified:
type: string
format: date-time
externalDateExpires:
type: string
format: date-time
firstSeen:
type: string
format: date-time
lastSeen:
type: string
format: date-time
associatedCases:
$ref: '#/components/schemas/ListEntityCase'
associatedArtifacts:
$ref: '#/components/schemas/ListEntityArtifact'
attributes:
$ref: '#/components/schemas/ListEntityGroupAttributeData'
handles:
$ref: '#/components/schemas/ListEntityAdversaryAsset'
urls:
$ref: '#/components/schemas/ListEntityAdversaryAsset'
fileName:
maxLength: 255
minLength: 0
type: string
fileSize:
type: integer
format: int64
status:
type: string
malware:
type: boolean
password:
type: string
documentType:
type: string
insights:
type: string
documentDateAdded:
type: string
format: date-time
to:
type: string
from:
maxLength: 100
minLength: 0
type: string
subject:
maxLength: 255
minLength: 0
type: string
score:
type: integer
format: int32
header:
maxLength: 65535
minLength: 0
type: string
body:
maxLength: 65535
minLength: 0
type: string
scoreIncludesBody:
type: boolean
emailDate:
type: string
format: date-time
scoreBreakdown:
type: string
eventDate:
type: string
format: date-time
fileType:
type: string
fileText:
type: string
signatureDateAdded:
type: string
format: date-time
publishDate:
type: string
format: date-time
escalated:
type: boolean
reminded:
type: boolean
overdue:
type: boolean
dueDate:
type: string
format: date-time
reminderDate:
type: string
format: date-time
escalationDate:
type: string
format: date-time
lastModified:
type: string
format: date-time
assignments:
$ref: '#/components/schemas/ListEntityTaskAssignee'
legacyLink:
type: string
GroupAttributeData:
required:
- groupId
- value
type: object
properties:
id:
type: integer
format: int64
dateAdded:
type: string
format: date-time
securityLabels:
$ref: '#/components/schemas/ListEntitySecurityLabel'
type:
type: string
value:
maxLength: 2147483647
minLength: 1
type: string
source:
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModified:
type: string
format: date-time
settings:
$ref: '#/components/schemas/AttributeSettings'
groupId:
type: integer
format: int64
group:
$ref: '#/components/schemas/Group'
pinned:
type: boolean
default:
type: boolean
Indicator:
required:
- type
type: object
properties:
id:
type: integer
format: int64
dateAdded:
type: string
format: date-time
securityLabels:
$ref: '#/components/schemas/ListEntitySecurityLabel'
ownerId:
type: integer
format: int64
ownerName:
type: string
webLink: