-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
CortexCoreIR.yml
2876 lines (2874 loc) · 109 KB
/
CortexCoreIR.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: Endpoint
defaultEnabled: true
commonfields:
id: Cortex Core - IR
version: -1
configuration:
- display: Incident type
name: incidentType
type: 13
required: false
- display: Server URL (copy URL from Core - click ? to see more info.)
name: url
type: 0
hidden: true
required: false
- display: API Key ID
name: apikey_id
type: 4
hidden: true
required: false
- display: API Key
name: apikey
type: 4
hidden: true
required: false
- additionalinfo: The timeout of the HTTP requests sent to Cortex API (in seconds).
defaultvalue: '120'
display: HTTP Timeout
name: timeout
type: 0
required: false
description: The Cortex Core IR integration uses the Cortex API for detection and response, by natively integrating network, endpoint, and cloud data to stop sophisticated attacks.
display: Investigation & Response
name: Cortex Core - IR
script:
commands:
- arguments:
- description: Links the response action to the triggered incident.
name: incident_id
- description: Interval in seconds between each poll.
name: interval_in_seconds
- description: Polling timeout in seconds.
name: timeout_in_seconds
- description: For polling use.
isArray: true
name: action_id
deprecated: true
- description: The endpoint ID (string) to isolate. Retrieve the string from the core-get-endpoints command.
name: endpoint_id
required: true
- auto: PREDEFINED
defaultValue: 'false'
description: Suppress an error when trying to isolate a disconnected endpoint. When set to false, an error is returned.
name: suppress_disconnected_endpoint_error
predefined:
- 'true'
- 'false'
description: Isolates the specified endpoint.
execution: true
name: core-isolate-endpoint
polling: true
outputs:
- contextPath: Core.Isolation.endpoint_id
description: The endpoint ID.
type: String
- arguments:
- description: Links the response action to the triggered incident.
name: incident_id
- description: The endpoint ID (string) to reverse the isolation. Retrieve it from the core-get-endpoints command.
name: endpoint_id
required: true
- auto: PREDEFINED
defaultValue: 'false'
description: Suppress an error when trying to unisolate a disconnected endpoint. When set to false, an error is be returned.
name: suppress_disconnected_endpoint_error
predefined:
- 'true'
- 'false'
- description: For polling use.
isArray: true
name: action_id
deprecated: true
- description: Interval in seconds between each poll.
name: interval_in_seconds
- description: Polling timeout in seconds.
name: timeout_in_seconds
description: Reverses the isolation of an endpoint.
execution: true
name: core-unisolate-endpoint
polling: true
outputs:
- contextPath: Core.UnIsolation.endpoint_id
description: Isolates the specified endpoint.
type: String
- arguments:
- description: A comma-separated list of endpoint IDs.
isArray: true
name: endpoint_id_list
- description: "A comma-separated list of distribution package names or installation package names. \nExample: dist_name1,dist_name2."
isArray: true
name: dist_name
- description: |-
A comma-separated list of private IP addresses.
Example: 10.1.1.1,192.168.1.1.
isArray: true
name: ip_list
- description: |-
A comma-separated list of public IP addresses that correlate to the last IPv4 address from which the Cortex XDR agent connected (know as `Last Origin IP`).
Example: 8.8.8.8,1.1.1.1.
isArray: true
name: public_ip_list
- description: |-
The group name to which the agent belongs.
Example: group_name1,group_name2.
isArray: true
name: group_name
- description: 'The endpoint platform. Valid values are\: "windows", "linux", "macos", or "android". '
isArray: true
name: platform
auto: PREDEFINED
predefined:
- windows
- linux
- macos
- android
- description: |-
A comma-separated list of alias names.
Examples: alias_name1,alias_name2.
name: alias_name
isArray: true
- description: |-
Specifies whether the endpoint was isolated or unisolated.
name: isolate
auto: PREDEFINED
predefined:
- isolated
- unisolated
- description: |-
Hostname
Example: hostname1,hostname2.
name: hostname
isArray: true
- description: |-
All the agents that were first seen after {first_seen_gte}.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: first_seen_gte
- description: |-
All the agents that were first seen before {first_seen_lte}.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: first_seen_lte
- description: |-
All the agents that were last seen before {last_seen_gte}.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: last_seen_gte
- description: |-
All the agents that were last seen before {last_seen_lte}.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: last_seen_lte
- defaultValue: '0'
description: Page number (for pagination). The default is 0 (the first page).
name: page
- description: Maximum number of endpoints to return per page. The default and maximum is 30.
name: limit
defaultValue: '30'
- auto: PREDEFINED
description: Specifies whether to sort endpoints by the first time or last time they were seen. Can be "first_seen" or "last_seen".
name: sort_by
predefined:
- first_seen
- last_seen
- auto: PREDEFINED
description: The order by which to sort results. Can be "asc" (ascending) or "desc" ( descending). Default set to asc.
name: sort_order
predefined:
- asc
- desc
defaultValue: asc
- name: status
description: A comma-separated list of endpoints statuses to filter.
isArray: true
auto: PREDEFINED
predefined:
- connected
- disconnected
- lost
- uninstalled
- name: username
description: The usernames to query for, accepts a single user, or comma-separated list of usernames.
isArray: true
description: Gets a list of endpoints, according to the passed filters. If there are no filters, all endpoints are returned. Filtering by multiple fields will be concatenated using AND condition (OR is not supported). Maximum result set size is 100. Offset is the zero-based number of endpoint from the start of the result set (start by counting from 0).
name: core-get-endpoints
outputs:
- contextPath: Core.Endpoint.endpoint_id
description: The endpoint ID.
type: String
- contextPath: Core.Endpoint.endpoint_name
description: The endpoint name.
type: String
- contextPath: Core.Endpoint.endpoint_type
description: The endpoint type.
type: String
- contextPath: Core.Endpoint.endpoint_status
description: The status of the endpoint.
type: String
- contextPath: Core.Endpoint.os_type
description: The endpoint OS type.
type: String
- contextPath: Core.Endpoint.ip
description: A list of IP addresses.
type: Unknown
- contextPath: Core.Endpoint.users
description: A list of users.
type: Unknown
- contextPath: Core.Endpoint.domain
description: The endpoint domain.
type: String
- contextPath: Core.Endpoint.alias
description: The endpoint's aliases.
type: String
- contextPath: Core.Endpoint.first_seen
description: First seen date/time in Epoch (milliseconds).
type: Unknown
- contextPath: Core.Endpoint.last_seen
description: Last seen date/time in Epoch (milliseconds).
type: Date
- contextPath: Core.Endpoint.content_version
description: Content version.
type: String
- contextPath: Core.Endpoint.installation_package
description: Installation package.
type: String
- contextPath: Core.Endpoint.active_directory
description: Active directory.
type: String
- contextPath: Core.Endpoint.install_date
description: Install date in Epoch (milliseconds).
type: Date
- contextPath: Core.Endpoint.endpoint_version
description: Endpoint version.
type: String
- contextPath: Core.Endpoint.is_isolated
description: Whether the endpoint is isolated.
type: String
- contextPath: Core.Endpoint.group_name
description: The name of the group to which the endpoint belongs.
type: String
- contextPath: Endpoint.Hostname
description: The hostname that is mapped to this endpoint.
type: String
- contextPath: Endpoint.ID
description: The unique ID within the tool retrieving the endpoint.
type: String
- contextPath: Endpoint.IPAddress
description: The IP address of the endpoint.
type: String
- contextPath: Endpoint.Domain
description: The domain of the endpoint.
type: String
- contextPath: Endpoint.OS
description: The endpoint's operation system.
type: String
- contextPath: Account.Username
description: The username in the relevant system.
type: String
- contextPath: Account.Domain
description: The domain of the account.
type: String
- contextPath: Endpoint.Status
description: The endpoint's status.
type: String
- contextPath: Endpoint.IsIsolated
description: The endpoint's isolation status.
type: String
- contextPath: Endpoint.MACAddress
description: The endpoint's MAC address.
type: String
- contextPath: Endpoint.Vendor
description: The integration name of the endpoint vendor.
type: String
- arguments:
- description: The status of the endpoint to use as a filter.
name: status
auto: PREDEFINED
predefined:
- connected
- disconnected
- description: A comma-separated list of endpoint IDs to use as a filter.
isArray: true
name: endpoint_id_list
- description: |-
A comma-separated list of distribution package names or installation package names to use as a filter.
Example: dist_name1,dist_name2.
isArray: true
name: dist_name
- description: |-
A comma-separated list of IP addresses to use as a filter.
Example: 8.8.8.8,1.1.1.1.
isArray: true
name: ip_list
- description: A comma-separated list of group names to which the agent belongs to use as a filter.
isArray: true
name: group_name
- description: The endpoint platform to use as a filter.
isArray: true
name: platform
auto: PREDEFINED
predefined:
- windows
- linux
- macos
- android
- description: |-
A comma-separated list of alias names to use as a filter.
Examples: alias_name1,alias_name2.
isArray: true
name: alias_name
- auto: PREDEFINED
description: Specifies whether the endpoint was isolated or unisolated to use as a filter.
name: isolate
predefined:
- isolated
- unisolated
- description: A comma-separated list of hostnames to use as a filter.
isArray: true
name: hostname
- description: |-
All the agents that were first seen after {first_seen_gte} to use as a filter.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: first_seen_gte
- description: |-
All the agents that were first seen before {first_seen_lte} to use as a filter.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: first_seen_lte
- description: |-
All the agents that were last seen after {last_seen_gte} to use as a filter.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: last_seen_gte
- description: |-
All the agents that were last seen before {last_seen_lte} to use as a filter.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: last_seen_lte
- name: username
description: The usernames to use as a filter. Accepts a single user, or comma-separated list of usernames.
isArray: true
- name: new_alias_name
required: true
description: |-
The alias name to change to.
Note: If you send an empty field, (e.g., new_alias_name=\"\") the current alias name is deleted.
- name: scan_status
description: The scan status of the endpoint to use as a filter.
auto: PREDEFINED
predefined:
- none
- pending
- in_progress
- canceled
- aborted
- pending_cancellation
- success
- error
description: Gets a list of endpoints according to the passed filters, and changes their alias name. Filtering by multiple fields will be concatenated using the AND condition (OR is not supported).
name: core-endpoint-alias-change
- description: Gets a list of all the agent versions to use for creating a distribution list.
name: core-get-distribution-versions
outputs:
- contextPath: Core.DistributionVersions.windows
description: A list of Windows agent versions.
type: Unknown
- contextPath: Core.DistributionVersions.linux
description: A list of Linux agent versions.
type: Unknown
- contextPath: Core.DistributionVersions.macos
description: A list of Mac agent versions.
type: Unknown
- arguments:
- description: A string representing the name of the installation package.
name: name
required: true
- auto: PREDEFINED
description: "String, valid values are:\n• windows \n• linux\n• macos \n• android."
name: platform
predefined:
- windows
- linux
- macos
- android
required: true
- auto: PREDEFINED
description: |-
A string representing the type of package to create.
standalone - An installation for a new agent
upgrade - An upgrade of an agent from ESM.
name: package_type
predefined:
- standalone
- upgrade
required: true
- description: agent_version returned from core-get-distribution-versions. Not required for Android platfoms.
name: agent_version
required: true
- description: Information about the package.
name: description
description: Creates an installation package. This is an asynchronous call that returns the distribution ID. This does not mean that the creation succeeded. To confirm that the package has been created, check the status of the distribution by running the Get Distribution Status API.
name: core-create-distribution
outputs:
- contextPath: Core.Distribution.id
description: The installation package ID.
type: String
- contextPath: Core.Distribution.name
description: The name of the installation package.
type: String
- contextPath: Core.Distribution.platform
description: The installation OS.
type: String
- contextPath: Core.Distribution.agent_version
description: Agent version.
type: String
- contextPath: Core.Distribution.description
description: Information about the package.
type: String
- arguments:
- description: |-
The ID of the installation package.
Copy the distribution_id from the "id" field on Endpoints > Agent Installation page.
name: distribution_id
required: true
- auto: PREDEFINED
description: |-
The installation package type. Valid
values are:
• upgrade
• sh - For Linux
• rpm - For Linux
• deb - For Linux
• pkg - For Mac
• x86 - For Windows
• x64 - For Windows.
name: package_type
predefined:
- upgrade
- sh
- rpm
- deb
- pkg
- x86
- x64
required: true
description: Gets the distribution URL for downloading the installation package.
name: core-get-distribution-url
outputs:
- contextPath: Core.Distribution.id
description: Distribution ID.
type: String
- contextPath: Core.Distribution.url
description: URL for downloading the installation package.
type: String
- arguments:
- description: Status of distribution IDs, in a comma-separated list.
isArray: true
name: distribution_ids
required: true
description: Gets the status of the installation package.
name: core-get-create-distribution-status
outputs:
- contextPath: Core.Distribution.id
description: Distribution ID.
type: String
- contextPath: Core.Distribution.status
description: Installation package status.
type: String
- arguments:
- description: User’s email address.
name: email
- auto: PREDEFINED
description: The audit log type.
name: type
predefined:
- REMOTE_TERMINAL
- RULES
- AUTH
- RESPONSE
- INCIDENT_MANAGEMENT
- ENDPOINT_MANAGEMENT
- ALERT_WHITELIST
- PUBLIC_API
- DISTRIBUTIONS
- STARRED_INCIDENTS
- POLICY_PROFILES
- DEVICE_CONTROL_PROFILE
- HOST_FIREWALL_PROFILE
- POLICY_RULES
- PROTECTION_POLICY
- DEVICE_CONTROL_TEMP_EXCEPTIONS
- DEVICE_CONTROL_GLOBAL_EXCEPTIONS
- GLOBAL_EXCEPTIONS
- MSSP
- REPORTING
- DASHBOARD
- BROKER_VM
- description: The audit log subtype.
name: sub_type
- auto: PREDEFINED
description: Result type.
name: result
predefined:
- SUCCESS
- FAIL
- PARTIAL
- description: |-
Return logs when the timestamp is after 'log_time_after'.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: timestamp_gte
- description: |-
Return logs when the timestamp is before the 'log_time_after'.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: timestamp_lte
- defaultValue: '0'
description: Page number (for pagination). The default is 0 (the first page).
name: page
- defaultValue: '30'
description: Maximum number of audit logs to return per page. The default and maximum is 30.
name: limit
- auto: PREDEFINED
description: Specifies the field by which to sort the results. By default the sort is defined as creation-time and descending. Can be "type", "sub_type", "result", or "timestamp".
name: sort_by
predefined:
- type
- sub_type
- result
- timestamp
- auto: PREDEFINED
defaultValue: desc
description: The sort order. Can be "asc" (ascending) or "desc" (descending). Default set to "desc".
name: sort_order
predefined:
- asc
- desc
description: Gets management logs. You can filter by multiple fields, which will be concatenated using the AND condition (OR is not supported). Maximum result set size is 100. Offset is the zero-based number of management logs from the start of the result set (start by counting from 0).
name: core-get-audit-management-logs
outputs:
- contextPath: Core.AuditManagementLogs.AUDIT_ID
description: Audit log ID.
type: Number
- contextPath: Core.AuditManagementLogs.AUDIT_OWNER_NAME
description: Audit owner name.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_OWNER_EMAIL
description: Audit owner email address.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_ASSET_JSON
description: Asset JSON.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_ASSET_NAMES
description: Audit asset names.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_HOSTNAME
description: Host name.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_RESULT
description: Audit result.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_REASON
description: Audit reason.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_DESCRIPTION
description: Description of the audit.
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_ENTITY
description: Audit entity (e.g., AUTH, DISTRIBUTIONS).
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_ENTITY_SUBTYPE
description: Entity subtype (e.g., Login, Create).
type: String
- contextPath: Core.AuditManagementLogs.AUDIT_CASE_ID
description: Audit case ID.
type: Number
- contextPath: Core.AuditManagementLogs.AUDIT_INSERT_TIME
description: Log's insert time.
type: Date
- arguments:
- description: A comma-separated list of endpoint IDs.
isArray: true
name: endpoint_ids
- description: A comma-separated list of endpoint names.
isArray: true
name: endpoint_names
- auto: PREDEFINED
description: The report type. Can be "Installation", "Policy", "Action", "Agent Service", "Agent Modules", or "Agent Status".
isArray: true
name: type
predefined:
- Installation
- Policy
- Action
- Agent Service
- Agent Modules
- Agent Status
- auto: PREDEFINED
description: The report subtype.
isArray: true
name: sub_type
predefined:
- Install
- Uninstall
- Upgrade
- Local Configuration
- Content Update
- Policy Update
- Process Exception
- Hash Exception
- Scan
- File Retrieval
- File Scan
- Terminate Process
- Isolate
- Cancel Isolation
- Payload Execution
- Quarantine
- Restore
- Stop
- Start
- Module Initialization
- Local Analysis Model
- Local Analysis Feature Extraction
- Fully Protected
- OS Incompatible
- Software Incompatible
- Kernel Driver Initialization
- Kernel Extension Initialization
- Proxy Communication
- Quota Exceeded
- Minimal Content
- Reboot Eequired
- Missing Disc Access
- auto: PREDEFINED
description: The result type. Can be "Success" or "Fail". If not passed, returns all event reports.
isArray: true
name: result
predefined:
- Success
- Fail
- description: |-
Return logs that their timestamp is greater than 'log_time_after'.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: timestamp_gte
- description: |-
Return logs for which the timestamp is before the 'timestamp_lte'.
Supported values:
1579039377301 (time in milliseconds)
"3 days" (relative date)
"2019-10-21T23:45:00" (date).
name: timestamp_lte
- defaultValue: '0'
description: Page number (for pagination). The default is 0 (the first page).
name: page
- defaultValue: '30'
description: The maximum number of reports to return. Default and maximum is 30.
name: limit
- auto: PREDEFINED
description: The field by which to sort results. Can be "type", "category", "trapsversion", "timestamp", or "domain").
name: sort_by
predefined:
- type
- category
- trapsversion
- timestamp
- domain
- auto: PREDEFINED
defaultValue: asc
description: The sort order. Can be "asc" (ascending) or "desc" (descending). Default is "asc".
name: sort_order
predefined:
- asc
- desc
description: Gets agent event reports. You can filter by multiple fields, which will be concatenated using the AND condition (OR is not supported). Maximum result set size is 100. Offset is the zero-based number of reports from the start of the result set (start by counting from 0).
name: core-get-audit-agent-reports
outputs:
- contextPath: Core.AuditAgentReports.ENDPOINTID
description: Endpoint ID.
type: String
- contextPath: Core.AuditAgentReports.ENDPOINTNAME
description: Endpoint name.
type: String
- contextPath: Core.AuditAgentReports.DOMAIN
description: Agent domain.
type: String
- contextPath: Core.AuditAgentReports.TRAPSVERSION
description: Traps version.
type: String
- contextPath: Core.AuditAgentReports.RECEIVEDTIME
description: Received time in Epoch time.
type: Date
- contextPath: Core.AuditAgentReports.TIMESTAMP
description: Timestamp in Epoch time.
type: Date
- contextPath: Core.AuditAgentReports.CATEGORY
description: Report category (e.g., Audit).
type: String
- contextPath: Core.AuditAgentReports.TYPE
description: Report type (e.g., Action, Policy).
type: String
- contextPath: Core.AuditAgentReports.SUBTYPE
description: Report subtype (e.g., Fully Protected,Policy Update,Cancel Isolation).
type: String
- contextPath: Core.AuditAgentReports.RESULT
description: Report result.
type: String
- contextPath: Core.AuditAgentReports.REASON
description: Report reason.
type: String
- contextPath: Core.AuditAgentReports.DESCRIPTION
description: Agent report description.
type: String
- contextPath: Endpoint.ID
description: The unique ID within the tool retrieving the endpoint.
type: String
- contextPath: Endpoint.Hostname
description: The hostname that is mapped to this endpoint.
type: String
- contextPath: Endpoint.Domain
description: The domain of the endpoint.
type: String
- arguments:
- description: Links the response action to the triggered incident.
name: incident_id
- description: String that represents a list of hashed files you want to block list. Must be a valid SHA256 hash.
isArray: true
name: hash_list
required: true
- description: String that represents additional information regarding the action.
name: comment
- auto: PREDEFINED
defaultValue: 'false'
description: Choose either regular response or detailed response. Default value = false, regular response.
name: detailed_response
predefined:
- 'true'
- 'false'
description: Block lists requested files which have not already been block listed or added to allow lists.
name: core-blocklist-files
outputs:
- contextPath: Core.blocklist.added_hashes
description: Added fileHash to blocklist.
type: Number
- contextPath: Core.blocklist.excluded_hashes
description: Added fileHash to blocklist.
type: Number
- arguments:
- description: Links the response action to the triggered incident.
name: incident_id
- description: String that represents a list of hashed files you want to add to allow lists. Must be a valid SHA256 hash.
isArray: true
name: hash_list
required: true
- description: String that represents additional information regarding the action.
name: comment
- auto: PREDEFINED
defaultValue: 'false'
description: Choose either regular response or detailed response. Default value = false, regular response.
name: detailed_response
predefined:
- 'true'
- 'false'
description: Adds requested files to allow list if they are not already on block list or allow list.
name: core-allowlist-files
outputs:
- contextPath: Core.allowlist.added_hashes
description: Added fileHash to allowlist.
type: Number
- contextPath: Core.allowlist.excluded_hashes
description: Added fileHash to allowlist.
type: Number
- arguments:
- description: Links the response action to the triggered incident.
name: incident_id
- description: List of endpoint IDs.
isArray: true
name: endpoint_id_list
required: true
- description: String that represents the path of the file you want to quarantine.
name: file_path
required: true
- description: String that represents the file’s hash. Must be a valid SHA256 hash.
name: file_hash
required: true
- description: For polling use.
isArray: true
name: action_id
deprecated: true
- description: Interval in seconds between each poll.
name: interval_in_seconds
- description: Polling timeout in seconds.
name: timeout_in_seconds
description: Quarantines a file on selected endpoints. You can select up to 1000 endpoints.
name: core-quarantine-files
polling: true
- arguments:
- description: String that represents the endpoint ID.
name: endpoint_id
required: true
- description: String that represents the file hash. Must be a valid SHA256 hash.
name: file_hash
required: true
- description: String that represents the file path.
name: file_path
required: true
description: Retrieves the quarantine status for a selected file.
name: core-get-quarantine-status
- arguments:
- description: Links the response action to the incident that triggered it.
name: incident_id
- description: String that represents the file in hash. Must be a valid SHA256 hash.
name: file_hash
required: true
- description: String that represents the endpoint ID. If you do not enter a specific endpoint ID, the request will run restore on all endpoints which relate to the quarantined file you defined.
name: endpoint_id
- description: For polling use.
isArray: true
name: action_id
deprecated: true
- description: Interval in seconds between each poll.
name: interval_in_seconds
- description: Polling timeout in seconds.
name: timeout_in_seconds
description: Restores a quarantined file on requested endpoints.
name: core-restore-file
polling: true
- arguments:
- description: Links the response action to the triggered incident.
name: incident_id
- description: List of endpoint IDs.
isArray: true
name: endpoint_id_list
- description: Name of the distribution list.
isArray: true
name: dist_name
- description: Epoch timestamp in milliseconds.
name: gte_first_seen
- description: Epoch timestamp in milliseconds.
name: gte_last_seen
- description: Epoch timestamp in milliseconds.
name: lte_first_seen
- description: Epoch timestamp in milliseconds.
name: lte_last_seen
- description: List of IP addresses.
isArray: true
name: ip_list
- description: Name of the endpoint group.
isArray: true
name: group_name
- auto: PREDEFINED
description: Type of operating system.
isArray: true
name: platform
predefined:
- windows
- linux
- macos
- android
- description: Endpoint alias name.
isArray: true
name: alias
- auto: PREDEFINED
description: Choose if an endpoint has been isolated. Select "isolated" or "unisolated".
name: isolate
predefined:
- isolated
- unisolated
- description: Name of the host.
isArray: true
name: hostname
- auto: PREDEFINED
defaultValue: 'false'
description: Choose whether to scan all of the endpoints or not. Default is false. Scanning all of the endpoints may cause performance issues and latency.
name: all
predefined:
- 'true'
- 'false'
- description: For polling use.
isArray: true
name: action_id
deprecated: true
- description: Interval in seconds between each poll.
name: interval_in_seconds
- description: Polling timeout in seconds.
name: timeout_in_seconds
description: Runs a scan on a selected endpoint. To scan all endpoints, run this command with argument all=true. Note that scanning all the endpoints may cause performance issues and latency.
execution: true
name: core-endpoint-scan
polling: true
outputs:
- contextPath: Core.endpointScan.actionId
description: The action ID of the scan request.
type: Number
- contextPath: Core.endpointScan.aborted
description: Was the scan aborted.
type: Boolean
- arguments:
- description: Links the response action to the incident that triggered it.
name: incident_id
- description: List of endpoint IDs.
isArray: true
name: endpoint_id_list
- description: Name of the distribution list.
isArray: true
name: dist_name
- description: Epoch timestamp in milliseconds.
name: gte_first_seen
- description: Epoch timestamp in milliseconds.
name: gte_last_seen
- description: Epoch timestamp in milliseconds.
name: lte_first_seen
- description: Epoch timestamp in milliseconds.
name: lte_last_seen
- description: List of IP addresses.
isArray: true
name: ip_list
- description: Name of the endpoint group.
isArray: true
name: group_name
- auto: PREDEFINED
description: Type of operating system.
isArray: true
name: platform
predefined:
- windows
- linux
- macos
- android
- description: Endpoint alias name.
isArray: true
name: alias
- auto: PREDEFINED
description: Choose whether an endpoint has been isolated. Select "isolated" or "unisolated".
name: isolate
predefined:
- isolated
- unisolated
- description: Name of the host.
isArray: true
name: hostname
- auto: PREDEFINED
defaultValue: 'false'
description: Whether to scan all of the endpoints or not. Default is false. Note that scanning all of the endpoints may cause performance issues and latency.
name: all
predefined:
- 'true'
- 'false'
description: Cancel the selected endpoints scan. A scan can only be cancelled if the selected endpoints are Pending or In Progress. To scan all endpoints, run the command with the argument all=true. Note that scanning all of the endpoints may cause performance issues and latency.
execution: true
name: core-endpoint-scan-abort
outputs:
- contextPath: Core.endpointScan.actionId
description: The action id of the abort scan request.
type: Unknown
- contextPath: Core.endpointScan.aborted
description: Was the scan cancelled.
type: Boolean
- arguments:
- description: The endpoint ID. Retrieve by running the core-get-endpoints command.
name: endpoint_id
required: true
description: Gets the policy name for a specific endpoint.
name: core-get-policy
outputs: