Describe an Anti-Malware Configuration
Describe an anti-malware configuration by ID.
AntiMalwareConfigurationsApi.describeAntiMalware([param1, param2, ...])
AntiMalwareConfigurationsApi.describe_anti_malware([param1, param2, ...])
AntiMalwareConfigurationsApi.describeAntiMalware([param1, param2, ...])
successful operation
Not authorized to view anti-malware configurations.
The anti-malware configuration does not exist.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AntiMalwareConfigurationsApi; import com.trendmicro.deepsecurity.model.AntiMalwareConfiguration; public class DescribeAntiMalwareExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AntiMalwareConfigurationsApi instance = new AntiMalwareConfigurationsApi(); Integer antiMalwareID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours AntiMalwareConfiguration result = instance.describeAntiMalware(antiMalwareID, apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling AntiMalwareConfigurationsApi.describeAntiMalware"); e.printStackTrace(); } } }
- 200
{- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "ID": 0,
- "cpuUsage": "low"
}
Modify an Anti-Malware Configuration
Modify an anti-malware configuration by ID. Any unset elements will be left unchanged.
AntiMalwareConfigurationsApi.modifyAntiMalware([param1, param2, ...])
AntiMalwareConfigurationsApi.modify_anti_malware([param1, param2, ...])
AntiMalwareConfigurationsApi.modifyAntiMalware([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the anti-malware configuration to modify.
successful operation
Not authorized to modify anti-malware configurations or the requested modification is not permitted.
The anti-malware configuration does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "cpuUsage": "low"
}
- 200
{- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "ID": 0,
- "cpuUsage": "low"
}
Delete an Anti-Malware Configuration
Delete an anti-malware configuration by ID.
AntiMalwareConfigurationsApi.deleteAntiMalware([param1, param2, ...])
AntiMalwareConfigurationsApi.delete_anti_malware([param1, param2, ...])
AntiMalwareConfigurationsApi.deleteAntiMalware([param1, param2, ...])
Request is successful.
Not authorized to delete anti-malware configurations.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AntiMalwareConfigurationsApi; public class DeleteAntiMalwareExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AntiMalwareConfigurationsApi instance = new AntiMalwareConfigurationsApi(); Integer antiMalwareID = 1; String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours instance.deleteAntiMalware(antiMalwareID, apiVersion); } catch (ApiException e) { System.err.println("An exception occurred when calling AntiMalwareConfigurationsApi.deleteAntiMalware"); e.printStackTrace(); } } }
List Anti-Malware Configurations
Lists all anti-malware configurations.
AntiMalwareConfigurationsApi.listAntiMalwares([param1, param2, ...])
AntiMalwareConfigurationsApi.list_anti_malwares([param1, param2, ...])
AntiMalwareConfigurationsApi.listAntiMalwares([param1, param2, ...])
successful operation
Not authorized to view anti-malware configurations.
- Java
- Python
- JavaScript
import com.trendmicro.deepsecurity.ApiClient; import com.trendmicro.deepsecurity.Configuration; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.auth.ApiKeyAuth; import com.trendmicro.deepsecurity.ApiException; import com.trendmicro.deepsecurity.api.AntiMalwareConfigurationsApi; import com.trendmicro.deepsecurity.model.AntiMalwareConfigurations; public class ListAntiMalwaresExample { public static void main(String[] args) { // Setup ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("YOUR HOST"); // Authentication ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key"); Legacy API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key"); Trend Micro Cloud One API Key.setApiKey("YOUR API KEY"); try { defaultClient.trustAllCertificates(false); } catch (Exception e) { System.err.println("An exception occurred when calling ApiClient.trustAllCertificates"); e.printStackTrace(); } // Initialization // Set Any Required Values AntiMalwareConfigurationsApi instance = new AntiMalwareConfigurationsApi(); String apiVersion = "YOUR VERSION"; try { // Please replace the parameter values with yours AntiMalwareConfigurations result = instance.listAntiMalwares(apiVersion); System.out.println(result); } catch (ApiException e) { System.err.println("An exception occurred when calling AntiMalwareConfigurationsApi.listAntiMalwares"); e.printStackTrace(); } } }
- 200
{- "antiMalwareConfigurations": [
- {
- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "ID": 0,
- "cpuUsage": "low"
}
]
}
Create an Anti-Malware Configuration
Create a new anti-malware configuration.
AntiMalwareConfigurationsApi.createAntiMalware([param1, param2, ...])
AntiMalwareConfigurationsApi.create_anti_malware([param1, param2, ...])
AntiMalwareConfigurationsApi.createAntiMalware([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the new anti-malware configuration.
successful operation
Not authorized to create anti-malware configurations.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "cpuUsage": "low"
}
- 200
{- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "ID": 0,
- "cpuUsage": "low"
}
Search Anti-Malware Configurations
Search for anti-malware configurations using optional filters.
AntiMalwareConfigurationsApi.searchAntiMalwares([param1, param2, ...])
AntiMalwareConfigurationsApi.search_anti_malwares([param1, param2, ...])
AntiMalwareConfigurationsApi.searchAntiMalwares([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
Not authorized to view anti-malware configurations.
- Payload
- Java
- Python
- JavaScript
{- "maxItems": 0,
- "searchCriteria": [
- {
- "fieldName": "string",
- "booleanTest": true,
- "numericTest": "less-than",
- "numericValue": 0,
- "numericValueList": [
- 0
], - "stringTest": "equal",
- "stringValue": "string",
- "stringWildcards": true,
- "choiceTest": "equal",
- "choiceValue": "string",
- "firstDateValue": 0,
- "firstDateInclusive": true,
- "lastDateValue": 0,
- "lastDateInclusive": true,
- "nullTest": true,
- "versionTest": "less-than",
- "versionValue": "string",
- "idValue": 0,
- "idTest": "less-than",
- "idValueList": [
- 0
]
}
], - "sortByObjectID": true
}
- 200
{- "antiMalwareConfigurations": [
- {
- "name": "string",
- "description": "string",
- "scanType": "real-time",
- "documentExploitProtectionEnabled": true,
- "documentExploitProtection": "critical-only",
- "documentExploitHeuristicLevel": "default",
- "machineLearningEnabled": true,
- "behaviorMonitoringEnabled": true,
- "documentRecoveryEnabled": true,
- "intelliTrapEnabled": true,
- "memoryScanEnabled": true,
- "spywareEnabled": true,
- "alertEnabled": true,
- "directoriesToScan": "all-directories",
- "directoryListID": 0,
- "filesToScan": "all-files",
- "fileExtensionListID": 0,
- "excludedDirectoryListID": 0,
- "excludedFileListID": 0,
- "excludedFileExtensionListID": 0,
- "excludedProcessImageFileListID": 0,
- "realTimeScan": "read-only",
- "scanCompressedEnabled": true,
- "scanCompressedMaximumSize": 0,
- "scanCompressedMaximumLevels": 0,
- "scanCompressedMaximumFiles": 0,
- "microsoftOfficeEnabled": true,
- "microsoftOfficeLayers": 0,
- "networkDirectoriesEnabled": true,
- "customRemediationActionsEnabled": true,
- "customScanActionsEnabled": true,
- "scanActionForVirus": "pass",
- "scanActionForTrojans": "pass",
- "scanActionForPacker": "pass",
- "scanActionForSpyware": "pass",
- "scanActionForOtherThreats": "pass",
- "scanActionForCookies": "pass",
- "scanActionForCVE": "pass",
- "scanActionForHeuristics": "pass",
- "scanActionForPossibleMalware": "active-action",
- "amsiScanEnabled": true,
- "scanActionForBehaviorMonitoring": "active-action",
- "scanActionForMachineLearning": "pass",
- "scanActionForAmsi": "pass",
- "processMemoryScanAction": "active-action",
- "ID": 0,
- "cpuUsage": "low"
}
]
}