forked from demisto/content
-
Notifications
You must be signed in to change notification settings - Fork 13
/
CiscoUmbrellaReporting.yml
1542 lines (1541 loc) · 69.8 KB
/
CiscoUmbrellaReporting.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
category: Network Security
commonfields:
id: Cisco Umbrella Reporting
version: -1
configuration:
- additionalinfo: Cisco Umbrella Reporting API base URL.
defaultvalue: https://reports.api.umbrella.com
display: API URL
name: api_url
required: true
type: 0
- additionalinfo: Organization ID
display: Organization ID
name: organization_id
required: true
type: 0
- additionalinfo: Client ID and Client Secret.
display: Client ID
name: credentials
required: true
type: 9
- display: Trust any certificate (not secure)
name: insecure
type: 8
required: false
- display: Use system proxy settings
name: proxy
type: 8
required: false
description: The Umbrella Reporting v2 API provides visibility into your core network and security activities and Umbrella logs.
display: Cisco Umbrella Reporting
name: Cisco Umbrella Reporting
script:
commands:
- arguments:
- auto: PREDEFINED
default: true
description: Specify the type of traffic. By default, all supported traffic types are included.
name: traffic_type
predefined:
- dns
- proxy
- firewall
- ip
- description: A domain name or comma-separated list of domain names.
name: domains
- description: An IP address.
name: ip
- description: A URL or comma-separated list of URLs.
name: urls
- description: A port number or comma-separated list of port numbers.
name: ports
- description: A SHA-256 hash.
name: sha256
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: The maximum number of records to return from the collection. Limit default value is 50. If the page_size argument is set by the user then the limit argument will be ignored.
name: limit
- description: An identity type or comma-separated list of identity types.
name: identity_types
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
description: List of destinations ordered by the number of requests made in descending order.
name: umbrella-reporting-destination-list
outputs:
- contextPath: UmbrellaReporting.Destination.count
description: Total number of requests made for this destination.
type: Number
- contextPath: UmbrellaReporting.Destination.domain
description: Destination.
type: String
- contextPath: UmbrellaReporting.Destination.bandwidth
description: The total bandwidth of proxy requests uploaded and downloaded for this destination.
type: Number
- contextPath: UmbrellaReporting.Destination.rank
description: The rank of the result based on the number of requests.
type: Number
- contextPath: UmbrellaReporting.Destination.policycategories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.Destination.policycategories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.Destination.policycategories.type
description: The type of category.
type: String
- contextPath: UmbrellaReporting.Destination.policycategories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.Destination.policycategories.integration
description: Whether the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.Destination.categories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.Destination.categories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.Destination.categories.type
description: The type of category.
type: String
- contextPath: UmbrellaReporting.Destination.categories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.Destination.categories.integration
description: Whether the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.Destination.counts.allowedrequests
description: Number of requests that were allowed.
type: Number
- contextPath: UmbrellaReporting.Destination.counts.blockedrequests
description: Number of requests that were blocked.
type: Number
- contextPath: UmbrellaReporting.Destination.counts.requests
description: Total number of requests.
type: Number
- arguments:
- auto: PREDEFINED
default: true
description: Specify the type of traffic. By default, all supported traffic types are included.
name: traffic_type
predefined:
- dns
- proxy
- ip
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: A domain name or comma-separated list of domain names.
name: domains
- description: A URL or comma-separated list of URLs.
name: urls
- description: An IP address.
name: ip
- description: A SHA-256 hash.
name: sha256
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: An identity type or comma-separated list of identity types.
name: identity_types
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: The page number (page size is 50 entries at max). Default is 1.
name: page
description: List of categories ordered by the number of requests made matching the categories in descending order.
name: umbrella-reporting-category-list
outputs:
- contextPath: UmbrellaReporting.Category.count
description: Number of requests made that match this category.
type: Number
- contextPath: UmbrellaReporting.Category.bandwidth
description: The total bandwidth of proxy requests uploaded and downloaded for this category.
type: String
- contextPath: UmbrellaReporting.Category.category.id
description: Category ID.
type: Number
- contextPath: UmbrellaReporting.Category.category.type
description: Category type.
type: String
- contextPath: UmbrellaReporting.Category.category.label
description: Category label.
type: String
- contextPath: UmbrellaReporting.Category.category.integration
description: Category integration.
type: Boolean
- contextPath: UmbrellaReporting.Category.category.deprecated
description: Category deprecated.
type: String
- contextPath: UmbrellaReporting.Category.rank
description: Rank of the category.
type: Number
- arguments:
- auto: PREDEFINED
default: true
description: Specify the type of traffic. By default, all supported traffic types are included.
name: traffic_type
predefined:
- dns
- proxy
- firewall
- ip
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: A domain name or comma-separated list of domain names.
name: domains
- description: A URL or comma-separated list of URLs.
name: urls
- description: An IP address.
name: ip
- description: A port number or comma-separated list of port numbers.
name: ports
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: A SHA-256 hash.
name: sha256
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: An identity type or comma-separated list of identity types.
name: identity_types
- description: The maximum number of records to return from the collection. Limit default value is 50. If the page_size argument is set by the user then the limit argument will be ignored.
name: limit
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
description: List of identities ordered by the number of requests made matching the categories in descending order.
name: umbrella-reporting-identity-list
outputs:
- contextPath: UmbrellaReporting.Identity.requests
description: Total number of requests made by this identity.
type: Number
- contextPath: UmbrellaReporting.Identity.bandwidth
description: The total bandwidth of proxy requests uploaded and downloaded for this identity.
type: Number
- contextPath: UmbrellaReporting.Identity.rank
description: The rank of the result based on the number of requests.
type: Number
- contextPath: UmbrellaReporting.Identity.counts.allowedrequests
description: Number of requests that were allowed.
type: Number
- contextPath: UmbrellaReporting.Identity.counts.blockedrequests
description: Number of requests that were blocked.
type: Number
- contextPath: UmbrellaReporting.Identity.counts.requests
description: Total number of requests.
type: Number
- contextPath: UmbrellaReporting.Identity.identity.id
description: Identity ID.
type: Number
- contextPath: UmbrellaReporting.Identity.identity.type.id
description: Origin type for the identity.
type: Number
- contextPath: UmbrellaReporting.Identity.identity.type.type
description: Origin type name for the identity.
type: String
- contextPath: UmbrellaReporting.Identity.identity.type.label
description: Origin type label for the identity.
type: String
- contextPath: UmbrellaReporting.Identity.identity.label
description: Label for the identity.
type: String
- contextPath: UmbrellaReporting.Identity.identity.deleted
description: Indicates whether the identity was deleted.
type: Boolean
- arguments:
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: A domain name or comma-separated list of domain names.
name: domains
- description: A URL or comma-separated list of URLs.
name: urls
- description: An IP address.
name: ip
- description: An identity type or comma-separated list of identity types.
name: identity_types
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
description: 'List of event types ordered by the number of requests made for each type of event in descending order. The event types are: domain_security, domain_integration, url_security, url_integration, cisco_amp and antivirus.'
name: umbrella-reporting-event-type-list
outputs:
- contextPath: UmbrellaReporting.EventType.eventtype
description: The event type. One of "domain_security", "domain_integration", "url_security", "url_integration", "cisco_amp" and "antivirus".
type: String
- contextPath: UmbrellaReporting.EventType.count
description: Number of requests made that match this event type.
type: Number
- arguments:
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: The maximum number of records to return from the collection. Limit default value is 50. If the page_size argument is set by the user then the limit argument will be ignored.
name: limit
- description: A domain name or comma-separated list of domain names.
name: domains
- description: A URL or comma-separated list of URLs.
name: urls
- description: An IP address.
name: ip
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: A SHA-256 hash.
name: sha256
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: An identity type or comma-separated list of identity types.
name: identity_types
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
description: List of files within a time frame. Only returns proxy data.
name: umbrella-reporting-file-list
outputs:
- contextPath: UmbrellaReporting.File.requests
description: Number of requests.
type: Number
- contextPath: UmbrellaReporting.File.identitycount
description: Number of identities for entry.
type: Number
- contextPath: UmbrellaReporting.File.sha256
description: SHA256 for entry.
type: String
- contextPath: UmbrellaReporting.File.filenames
description: Array of filenames for entry.
type: Unknown
- contextPath: UmbrellaReporting.File.filetypes
description: Array of file types for entry.
type: Unknown
- contextPath: UmbrellaReporting.File.categories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.File.categories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.File.categories.type
description: The type of category.
type: String
- contextPath: UmbrellaReporting.File.categories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.File.categories.integration
description: Whether the category is an integration.
type: Boolean
- arguments:
- auto: PREDEFINED
default: true
description: Specify the type of traffic. By default, all supported traffic types are included.
name: traffic_type
predefined:
- dns
- proxy
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: The maximum number of records to return from the collection. Limit default value is 50. If the page_size argument is set by the user then the limit argument will be ignored.
name: limit
- description: A domain name or comma-separated list of domain names.
name: domains
- description: An IP address.
name: ip
- description: An identity type or comma-separated list of identity types.
name: identity_types
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
description: List of top threats within a time frame. Returns both DNS and Proxy data.
name: umbrella-reporting-threat-list
outputs:
- contextPath: UmbrellaReporting.Threat.threat
description: The threat name.
type: String
- contextPath: UmbrellaReporting.Threat.threattype
description: The threat type.
type: String
- contextPath: UmbrellaReporting.Threat.count
description: The number of requests for that threat name.
type: Number
- arguments:
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: The maximum number of records to return from the collection. Limit default value is 50. If the page_size argument is set by the user then the limit argument will be ignored.
name: limit
- description: A domain name or comma-separated list of domain names.
name: domains
- description: A URL or comma-separated list of URLs.
name: urls
- description: An IP address.
name: ip
- description: A port number or comma-separated list of port numbers.
name: ports
- description: An identity type or comma-separated list of identity types.
name: identity_types
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: A string that identifies a filename. Filter the request by the filename. Supports globbing or use of the wildcard character (''). The asterisk (*) matches zero or more occurrences of any character.
name: file_name
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
description: List all activity entries (dns/proxy/firewall/ip/intrusion/amp) within the time frame.
name: umbrella-reporting-activity-list
outputs:
- contextPath: UmbrellaReporting.Activity.type
description: Type of the request.
type: String
- contextPath: UmbrellaReporting.Activity.externalip
description: External IP address for entry.
type: String
- contextPath: UmbrellaReporting.Activity.internalip
description: Internal IP address for entry.
type: String
- contextPath: UmbrellaReporting.Activity.policycategories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.Activity.policycategories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.Activity.policycategories.type
description: Type of the request. A DNS request always has type dns.
type: String
- contextPath: UmbrellaReporting.Activity.policycategories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.Activity.policycategories.integration
description: Whether the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.Activity.categories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.Activity.categories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.Activity.categories.type
description: The type of category.
type: String
- contextPath: UmbrellaReporting.Activity.categories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.Activity.categories.integration
description: Whether the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.Activity.verdict
description: Verdict for entry.
type: String
- contextPath: UmbrellaReporting.Activity.domain
description: Domain for entry.
type: String
- contextPath: UmbrellaReporting.Activity.timestamp
description: Timestamp in ms.
type: Number
- contextPath: UmbrellaReporting.Activity.time
description: The time in 24 hour format based on the time zone parameter.
type: String
- contextPath: UmbrellaReporting.Activity.date
description: The date from the timestamp based on the time zone parameter.
type: String
- contextPath: UmbrellaReporting.Activity.identities.id
description: ID of the identity.
type: Number
- contextPath: UmbrellaReporting.Activity.identities.type.id
description: Origin type for the identity.
type: Number
- contextPath: UmbrellaReporting.Activity.identities.type.type
description: Origin type name for the identity.
type: String
- contextPath: UmbrellaReporting.Activity.identities.type.label
description: Origin type label for the identity.
type: String
- contextPath: UmbrellaReporting.Activity.identities.label
description: Label for the identity.
type: String
- contextPath: UmbrellaReporting.Activity.identities.deleted
description: Indicates whether the identity was deleted.
type: Boolean
- contextPath: UmbrellaReporting.Activity.threats.label
description: The threat name or label.
type: Boolean
- contextPath: UmbrellaReporting.Activity.threats.type
description: The type of threat.
type: String
- contextPath: UmbrellaReporting.Activity.allapplications.id
description: ID of the application.
type: Number
- contextPath: UmbrellaReporting.Activity.allapplications.type
description: Type of the application, NBAR or AVC.
type: String
- contextPath: UmbrellaReporting.Activity.allapplications.label
description: Label of the application.
type: String
- contextPath: UmbrellaReporting.Activity.allapplications.category.label
description: Label of the application category.
type: String
- contextPath: UmbrellaReporting.Activity.allapplications.category.id
description: ID of the application category.
type: Number
- contextPath: UmbrellaReporting.Activity.allowedapplications.id
description: ID of the application.
type: Number
- contextPath: UmbrellaReporting.Activity.allowedapplications.label
description: Label of the application.
type: String
- contextPath: UmbrellaReporting.Activity.allowedapplications.type
description: Type of the application, NBAR or AVC.
type: String
- contextPath: UmbrellaReporting.Activity.allowedapplications.category.label
description: Label of the application category.
type: String
- contextPath: UmbrellaReporting.Activity.allowedapplications.category.id
description: ID of the application category.
type: Number
- contextPath: UmbrellaReporting.Activity.querytype
description: The type of DNS request that was made. For more information, see Common DNS Request Types. https://support.umbrella.com/hc/en-us/articles/232254248-Common-DNS-return-codes-for-any-DNS-service-and-Umbrella-
type: String
- contextPath: UmbrellaReporting.Activity.returncode
description: The DNS return code for this request. For more information, see Common DNS return codes for any DNS service (and Umbrella). https://support.umbrella.com/hc/en-us/articles/232254248-Common-DNS-return-codes-for-any-DNS-service-and-Umbrella-
type: Number
- contextPath: UmbrellaReporting.Activity.blockedapplications.id
description: ID of the application.
type: Number
- contextPath: UmbrellaReporting.Activity.blockedapplications.label
description: Label of the application.
type: String
- contextPath: UmbrellaReporting.Activity.blockedapplications.type
description: Type of the application, NBAR or AVC.
type: String
- contextPath: UmbrellaReporting.Activity.blockedapplications.category.label
description: Label of the application category.
type: String
- contextPath: UmbrellaReporting.Activity.blockedapplications.category.id
description: ID of the application category.
type: Number
- arguments:
- auto: PREDEFINED
default: true
description: |-
Specify the type of traffic. By default, all supported traffic types are included.
Supported optional parameters for DNS traffic type are limit, from, to, offset, domains, ip, verdict, threats, threat_types.
Supported optional parameters for Proxy traffic type are limit, from, to, offset, domains, ip, verdict, threats, threat_types, urls, ports, identity_types, file_name, amp_disposition.
Supported optional parameters for Firewall traffic type are limit, from, to, offset, ip, ports, verdict.
Supported optional parameters for Intrusion traffic type are limit, from, to, offset, ip, ports, signatures, intrusion_action.
Supported optional parameters for IP traffic type are limit, from, to, offset, ip, ports, identity_types, verdict.
Supported optional parameters for Advanced Malware Protection (AMP) traffic type are limit, from, to, offset, amp_disposition, sha256.
name: traffic_type
predefined:
- dns
- proxy
- firewall
- intrusion
- ip
- amp
required: true
- description: A timestamp (milliseconds) or relative time string (for example:-1days' or '1639146300000'). Filter for data that appears after this time. Default is -7days.
name: from
- description: A timestamp (milliseconds) or relative time string (for example:'now' or 1661510185000). Filter for data that appears before this time. Default is 'now'.
name: to
- description: The maximum number of records to return from the collection. Limit default value is 50. If the page_size argument is set by the user then the limit argument will be ignored.
name: limit
- description: A domain name or comma-separated list of domain names.
name: domains
- description: A URL or comma-separated list of URLs.
name: urls
- description: An IP address.
name: ip
- description: A port number or comma-separated list of port numbers.
name: ports
- description: An identity type or comma-separated list of identity types.
name: identity_types
- auto: PREDEFINED
description: A verdict string.
name: verdict
predefined:
- allowed
- blocked
- proxied
- description: A string that identifies a filename. Filter the request by the filename. Supports globbing or use of the wildcard character (''). The asterisk (*) matches zero or more occurrences of any character.
name: file_name
- description: A threat name or comma-separated list of threat names.
name: threats
- description: A threat type or comma-separated list of threat types.
name: threat_types
- auto: PREDEFINED
description: An Advanced Malware Protection (AMP) disposition string.
name: amp_disposition
predefined:
- clean
- malicious
- unknown
- description: The page number. Default is 1.
name: page
- description: The number of requested results per page. Default is 50.
name: page_size
- description: A comma-separated list of Generator id - Signatures ID. Where Generator ID is unique id assigned to the part of the IPS which generated the event and Signature ID is used to uniquely identify signatures. Example:- 1-2,1-4.
name: signatures
- description: 'Comma-separated list of intrusion actions. Possible values: would_block, blocked, detected.'
name: intrusion_action
description: |-
List all entries within a time frame based on the traffic type selected. Valid activity types are dns, proxy, firewall, intrusion, ip, amp.
Only one activity type can be selected at a time.
name: umbrella-reporting-activity-get
outputs:
- contextPath: UmbrellaReporting.ActivityDns.type
description: Type of the request. A DNS request always has type DNS.
type: String
- contextPath: UmbrellaReporting.ActivityDns.externalip
description: External IP address for entry.
type: String
- contextPath: UmbrellaReporting.ActivityDns.internalip
description: Internal IP address for entry.
type: String
- contextPath: UmbrellaReporting.ActivityDns.policycategories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.policycategories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.ActivityDns.policycategories.type
description: Type of the request. A DNS request always has type dns.
type: String
- contextPath: UmbrellaReporting.ActivityDns.policycategories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.ActivityDns.policycategories.integration
description: Whether the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.ActivityDns.categories.id
description: ID of the category.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.categories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.ActivityDns.categories.type
description: The type of category.
type: String
- contextPath: UmbrellaReporting.ActivityDns.categories.deprecated
description: Whether the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.ActivityDns.categories.integration
description: Whether the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.ActivityDns.verdict
description: Verdict for entry.
type: String
- contextPath: UmbrellaReporting.ActivityDns.domain
description: Domain for entry.
type: String
- contextPath: UmbrellaReporting.ActivityDns.timestamp
description: Timestamp in ms.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.time
description: The time in 24 hour format based on the time zone parameter.
type: String
- contextPath: UmbrellaReporting.ActivityDns.date
description: The date from the timestamp based on the time zone parameter.
type: String
- contextPath: UmbrellaReporting.ActivityDns.identities.id
description: ID of the identity.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.identities.type.id
description: Origin type for the identity.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.identities.type.type
description: Origin type name for the identity.
type: String
- contextPath: UmbrellaReporting.ActivityDns.identities.type.label
description: Origin type label for the identity.
type: String
- contextPath: UmbrellaReporting.ActivityDns.identities.label
description: Label for the identity.
type: String
- contextPath: UmbrellaReporting.ActivityDns.identities.deleted
description: Indicates whether the identity was deleted.
type: Boolean
- contextPath: UmbrellaReporting.ActivityDns.threats.label
description: The threat name or label.
type: Boolean
- contextPath: UmbrellaReporting.ActivityDns.threats.type
description: The type of threat.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allapplications.id
description: ID of the application.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.allapplications.type
description: Type of the application, NBAR or AVC.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allapplications.label
description: Label of the application.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allapplications.category.label
description: Label of the application category.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allapplications.category.id
description: ID of the application category.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.allowedapplications.id
description: ID of the application.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.allowedapplications.label
description: Label of the application.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allowedapplications.type
description: Type of the application, NBAR or AVC.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allowedapplications.category.label
description: Label of the application category.
type: String
- contextPath: UmbrellaReporting.ActivityDns.allowedapplications.category.id
description: ID of the application category.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.querytype
description: The type of DNS request that was made. For more information, see https://support.umbrella.com/hc/en-us/articles/232254248-Common-DNS-return-codes-for-any-DNS-service-and-Umbrella-
type: String
- contextPath: UmbrellaReporting.ActivityDns.returncode
description: The DNS return code for this request. For more information, see Common DNS return codes for any DNS service (and Umbrella). https://support.umbrella.com/hc/en-us/articles/232254248-Common-DNS-return-codes-for-any-DNS-service-and-Umbrella-
type: Number
- contextPath: UmbrellaReporting.ActivityDns.blockedapplications.id
description: ID of the application.
type: Number
- contextPath: UmbrellaReporting.ActivityDns.blockedapplications.label
description: Label of the application.
type: String
- contextPath: UmbrellaReporting.ActivityDns.blockedapplications.type
description: Type of the application, NBAR or AVC.
type: String
- contextPath: UmbrellaReporting.ActivityDns.blockedapplications.category.label
description: Label of the application category.
type: String
- contextPath: UmbrellaReporting.ActivityDns.blockedapplications.category.id
description: ID of the application category.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.amp.disposition
description: Advanced Malware Protection (AMP) disposition.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.amp.malware
description: Advanced Malware Protection (AMP) malware.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.amp.score
description: Advanced Malware Protection (AMP) score.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.blockedfiletype
description: Locked file type for entry.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.bundleid
description: A proxy bundle ID.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.categories.deprecated
description: If the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.categories.id
description: ID of category.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.categories.integration
description: If the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.categories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.categories.type
description: The type of category.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.contenttype
description: The type of web content, typically text/html.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.datacenter.id
description: Unique ID for the data center.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.datacenter.label
description: Name of the data center.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.datalossprevention.state
description: If the request was Blocked for DLP. Either 'blocked' or ''.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.date
description: The date from the timestamp based on the timezone parameter.
type: Date
- contextPath: UmbrellaReporting.ActivityProxy.destinationip
description: Destination IP for entry.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.egress.ip
description: Egress IP.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.egress.type
description: Egress Type.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.externalip
description: External IP for entry.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.forwardingmethod
description: The request method (GET, POST, HEAD, etc.)
type: String
- contextPath: UmbrellaReporting.ActivityProxy.identities.deleted
description: Indicates whether the identity was deleted or not.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.identities.id
description: ID of identity.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.identities.label
description: Label for identity.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.identities.type.id
description: Origin type for identity.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.identities.type.label
description: Origin type label for identity.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.identities.type.type
description: Origin type name for identity.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.internalip
description: Internal IP for entry.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.isolated.fileaction
description: A string that describes the remote browser isolation (RBI) file action type.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.isolated.state
description: A string that describes the remote browser isolation(RBI) isolation type.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.policy.ruleid
description: The rule ID for the policy.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.policy.rulesetid
description: The rule set ID for the policy.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.policy.timebasedrule
description: Whether the policy triggered a time-of-day rule.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.policy.destinationlistids
description: The destination lists that the policy triggered.
type: Unknown
- contextPath: UmbrellaReporting.ActivityProxy.port
description: Request Port.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.referer
description: The referring domain or URL.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.requestmethod
description: The HTTP request method that was made.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.requestsize
description: Request size in bytes.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.responsefilename
description: Response filename for entry.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.responsesize
description: Response size in bytes.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.securityoverridden
description: Specify whether to filter on requests that override security.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.sha256
description: The hex digest of the response content.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.statuscode
description: The HTTP status code; should always be 200 or 201.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.tenantcontrols
description: If the request was part of a tenant control policy.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.time
description: The time in 24 hour format based on the timezone parameter.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.timestamp
description: Timestamp in ms.
type: Date
- contextPath: UmbrellaReporting.ActivityProxy.type
description: Type of the request. A Proxy request always has type Proxy.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.url
description: The URL requested.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.useragent
description: The browser agent that made the request.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.verdict
description: Verdict for entry.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.warnstatus
description: Warn Status.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.policycategories.id
description: ID of category.
type: Number
- contextPath: UmbrellaReporting.ActivityProxy.policycategories.label
description: The human readable label of the category.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.policycategories.type
description: Type of the request. A dns request always has type dns.
type: String
- contextPath: UmbrellaReporting.ActivityProxy.policycategories.deprecated
description: If the category is a legacy category.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.policycategories.integration
description: If the category is an integration.
type: Boolean
- contextPath: UmbrellaReporting.ActivityProxy.antivirusthreats.others
description: Other antivirus threats.
type: Unknown
- contextPath: UmbrellaReporting.ActivityProxy.antivirusthreats.puas
description: Potentially unwanted applications.
type: Unknown
- contextPath: UmbrellaReporting.ActivityProxy.antivirusthreats.viruses