System Settings

List System Settings

get/systemsettings

Lists all system settings.

Related SDK Methods:
Java

SystemSettingsApi.listSystemSettings([param1, param2, ...])
Python

SystemSettingsApi.list_system_settings([param1, param2, ...])
JavaScript

SystemSettingsApi.listSystemSettings([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view directory lists.

Request samples
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.SystemSettingsApi;
import com.trendmicro.deepsecurity.model.SystemSettings;


public class ListSystemSettingsExample {
	
	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
		SystemSettingsApi instance = new SystemSettingsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SystemSettings result = instance.listSystemSettings(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SystemSettingsApi.listSystemSettings");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "platformSettingSamlIdentityProviderCertificateExpiryWarningDays": {
    },
  • "platformSettingUpdateAgentSecurityOnMissingDeepSecurityManagerEnabled": {
    },
  • "platformSettingDdanManualSourceServerUrl": {
    },
  • "platformSettingSmartProtectionFeedbackThreatDetectionsThreshold": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterMedium": {
    },
  • "firewallSettingIntranetConnectivityTestExpectedContentRegex": {
    },
  • "platformSettingEventForwardingSnsEnabled": {
    },
  • "platformSettingTenantAutoRevokeImpersonationByPrimaryTenantTimeout": {
    },
  • "webReputationSettingEventRankRiskBlockedByAdministratorRank": {
    },
  • "antiMalwareSettingEventEmailRecipients": {
    },
  • "firewallSettingIntranetConnectivityTestUrl": {
    },
  • "platformSettingTenantUseDefaultRelayGroupFromPrimaryTenantEnabled": {
    },
  • "platformSettingExportedDiagnosticPackageLocale": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterCritical": {
    },
  • "platformSettingTrendMicroXdrCommonLogReceiverUrl": {
    },
  • "platformSettingManagedDetectResponseCompanyGuid": {
    },
  • "platformSettingAlertDefaultEmailAddress": {
    },
  • "platformSettingAgentInitiatedActivationReactivateClonedEnabled": {
    },
  • "platformSettingManagedDetectResponseServerUrl": {
    },
  • "platformSettingSyslogConfigId": {
    },
  • "platformSettingSmtpStartTlsEnabled": {
    },
  • "platformSettingUserPasswordRequireLettersAndNumbersEnabled": {
    },
  • "platformSettingManagedDetectResponseEnabled": {
    },
  • "platformSettingUpdateRulesPolicyAutoApplyEnabled": {
    },
  • "platformSettingUserPasswordRequireNotSameAsUsernameEnabled": {
    },
  • "logInspectionSettingEventRankSeverityMedium": {
    },
  • "antiMalwareSettingRetainEventDuration": {
    },
  • "platformSettingUpdateAgentSecurityContactPrimarySourceOnMissingRelayEnabled": {
    },
  • "firewallSettingEventRankSeverityLogOnly": {
    },
  • "applicationControlSettingRetainEventDuration": {
    },
  • "platformSettingWindowsUpgradeOnActivationEnabled": {
    },
  • "platformSettingSystemEventForwardingSnmpPort": {
    },
  • "firewallSettingEventRankSeverityDeny": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterLow": {
    },
  • "platformSettingManagedDetectResponseServiceToken": {
    },
  • "platformSettingSolutionCenterActivationDiagnosticPackage": {
    },
  • "platformSettingTrendMicroXdrApiUser": {
    },
  • "logInspectionSettingRetainEventDuration": {
    },
  • "platformSettingTenantAutoRevokeImpersonationByPrimaryTenantEnabled": {
    },
  • "antiMalwareSettingEventEmailBodyTemplate": {
    },
  • "platformSettingRetainSecurityUpdatesMax": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerSourceOption": {
    },
  • "antiMalwareSettingEventEmailEnabled": {
    },
  • "platformSettingRecommendationOngoingScansEnabled": {
    },
  • "platformSettingUserPasswordLengthMin": {
    },
  • "platformSettingAwsManagerIdentityUseInstanceRoleEnabled": {
    },
  • "platformSettingAlertAgentUpdatePendingThreshold": {
    },
  • "platformSettingUserPasswordRequireSpecialCharactersEnabled": {
    },
  • "deviceControlSettingRetainEventDuration": {
    },
  • "platformSettingUpdateApplianceDefaultAgentVersion": {
    },
  • "platformSettingSystemEventForwardingSnmpEnabled": {
    },
  • "platformSettingSmtpBounceEmailAddress": {
    },
  • "platformSettingUpdateRelaySecuritySupportAgent9AndEarlierEnabled": {
    },
  • "platformSettingManagedDetectResponseProxyId": {
    },
  • "platformSettingTrendMicroXdrLogServerUrl": {
    },
  • "platformSettingInactiveAgentCleanupEnabled": {
    },
  • "platformSettingUserSessionIdleTimeout": {
    },
  • "antiMalwareSettingEventEmailSubject": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerUseProxyEnabled": {
    },
  • "platformSettingAwsManagerIdentityAccessKey": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerProxyId": {
    },
  • "platformSettingTrendMicroXdrRegistrationState": {
    },
  • "platformSettingTenantAllowImpersonationByPrimaryTenantEnabled": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerManualSourceServerUrl": {
    },
  • "platformSettingUserPasswordRequireMixedCaseEnabled": {
    },
  • "platformSettingTrendMicroXdrIdentityProviderApiUrl": {
    },
  • "platformSettingSmartProtectionFeedbackForSuspiciousFileEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackIndustryType": {
    },
  • "webReputationSettingRetainEventDuration": {
    },
  • "platformSettingEnableAgentAutoDetectOsProxy": {
    },
  • "integrityMonitoringSettingEventRankSeverityMedium": {
    },
  • "platformSettingVisionOneThreatIntelligenceEnabled": {
    },
  • "platformSettingMacUpgradeOnActivationEnabled": {
    },
  • "platformSettingUpdateRelaySecurityAllRegionsPatternsDownloadEnabled": {
    },
  • "platformSettingDdanSubmissionEnabled": {
    },
  • "webReputationSettingEventRankRiskSuspicious": {
    },
  • "integrityMonitoringSettingEventRankSeverityCritical": {
    },
  • "platformSettingSmtpFromEmailAddress": {
    },
  • "firewallSettingGlobalStatefulConfigId": {
    },
  • "platformSettingEventForwardingSnsTopicArn": {
    },
  • "firewallSettingInternetConnectivityTestExpectedContentRegex": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerManualSourceApiKey": {
    },
  • "platformSettingUpdateSecurityPrimarySourceMode": {
    },
  • "webReputationSettingEventRankRiskDangerous": {
    },
  • "platformSettingUserHideUnlicensedModulesEnabled": {
    },
  • "platformSettingCaptureEncryptedTrafficEnabled": {
    },
  • "platformSettingRetainSystemEventDuration": {
    },
  • "platformSettingUserPasswordExpiry": {
    },
  • "platformSettingSmartProtectionFeedbackEnabled": {
    },
  • "integrityMonitoringSettingRetainEventDuration": {
    },
  • "logInspectionSettingEventRankSeverityCritical": {
    },
  • "platformSettingDdanProxyId": {
    },
  • "platformSettingAgentInitiatedActivationWithinIpListId": {
    },
  • "platformSettingUpdateSecurityPrimarySourceUrl": {
    },
  • "platformSettingAgentlessVcloudProtectionEnabled": {
    },
  • "platformSettingLinuxUpgradeOnActivationEnabled": {
    },
  • "platformSettingTrendMicroXdrEnabled": {
    },
  • "platformSettingActiveSessionsMaxExceededAction": {
    },
  • "platformSettingUpdateHostnameOnIpChangeEnabled": {
    },
  • "logInspectionSettingEventRankSeverityHigh": {
    },
  • "platformSettingSmtpRequiresAuthenticationEnabled": {
    },
  • "platformSettingActiveSessionsMax": {
    },
  • "platformSettingAwsExternalIdRetrievalEnabled": {
    },
  • "logInspectionSettingEventRankSeverityLow": {
    },
  • "platformSettingSmtpUsername": {
    },
  • "platformSettingXdrEnrolledVia": {
    },
  • "platformSettingEventForwardingSnsAdvancedConfigEnabled": {
    },
  • "firewallSettingInternetConnectivityTestInterval": {
    },
  • "platformSettingWhoisUrl": {
    },
  • "platformSettingDdanSourceOption": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerSuspiciousObjectListComparisonEnabled": {
    },
  • "platformSettingExportedFileCharacterEncoding": {
    },
  • "platformSettingUserSessionDurationMax": {
    },
  • "platformSettingUpdateSoftwareAlternateUpdateServerUrls": {
    },
  • "platformSettingRetainCountersDuration": {
    },
  • "platformSettingUpdateAgentSecurityPrimarySourceOnEdgeRelayEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackInterval": {
    },
  • "platformSettingSystemEventForwardingSnmpAddress": {
    },
  • "platformSettingSmtpServerAddress": {
    },
  • "platformSettingSmtpPassword": {
    },
  • "platformSettingEventForwardingSnsConfigJson": {
    },
  • "firewallSettingRetainEventDuration": {
    },
  • "webReputationSettingEventRankRiskUntested": {
    },
  • "platformSettingManagedDetectResponseUseProxyEnabled": {
    },
  • "platformSettingEventForwardingSnsSecretKey": {
    },
  • "platformSettingAwsManagerIdentitySecretKey": {
    },
  • "webReputationSettingEventRankRiskHighlySuspicious": {
    },
  • "platformSettingUserPasswordExpirySendEmailEnabled": {
    },
  • "platformSettingUserSignInAttemptsAllowedNumber": {
    },
  • "platformSettingAgentInitiatedActivationSupportVirtualDesktopInfrastructure": {
    },
  • "platformSettingDdanUseProxyEnabled": {
    },
  • "platformSettingOverwriteHostnameDuringHeartbeatEnabled": {
    },
  • "platformSettingAgentInitiatedActivationEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackBandwidthMaxKbytes": {
    },
  • "firewallSettingEventRankSeverityPacketRejection": {
    },
  • "platformSettingManagedDetectResponseUsePrimaryTenantSettingsEnabled": {
    },
  • "platformSettingEventForwardingSnsAccessKey": {
    },
  • "platformSettingAgentInitiatedActivationSpecifyHostnameEnabled": {
    },
  • "platformSettingConnectedThreatDefensesUsePrimaryTenantServerSettingsEnabled": {
    },
  • "platformSettingInactiveAgentCleanupDuration": {
    },
  • "platformSettingAgentInitiatedActivationDuplicateHostnameMode": {
    },
  • "platformSettingAllowPacketDataCaptureInNetworkEvents": {
    },
  • "platformSettingAgentInitiatedActivationReactivateUnknownEnabled": {
    },
  • "platformSettingAgentInitiatedActivationPolicyId": {
    },
  • "platformSettingTrendMicroXdrApiServerUrl": {
    },
  • "platformSettingRetainAgentInstallersPerPlatformMax": {
    },
  • "applicationControlSettingServeRulesetsFromRelaysEnabled": {
    },
  • "integrityMonitoringSettingEventRankSeverityHigh": {
    },
  • "platformSettingSamlRetainInactiveExternalAdministratorsDuration": {
    },
  • "intrusionPreventionSettingRetainEventDuration": {
    },
  • "firewallSettingInternetConnectivityTestUrl": {
    },
  • "platformSettingProxyAgentUpdateProxyId": {
    },
  • "platformSettingDdanAutoSubmissionEnabled": {
    },
  • "platformSettingDdanManualSourceApiKey": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterError": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterHigh": {
    },
  • "platformSettingTrendMicroXdrApiKey": {
    },
  • "platformSettingCloudOneWorkloadSecurityIocEnabled": {
    },
  • "integrityMonitoringSettingEventRankSeverityLow": {
    },
  • "platformSettingTrendMicroXdrCompanyId": {
    }
}

Modify System Settings

post/systemsettings

Modify the system settings. Any unset elements will be left unchanged.

Related SDK Methods:
Java

SystemSettingsApi.modifySystemSettings([param1, param2, ...])
Python

SystemSettingsApi.modify_system_settings([param1, param2, ...])
JavaScript

SystemSettingsApi.modifySystemSettings([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The system settings to modify.

object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
object (SettingValue)
Responses
200

successful operation

403

Not authorized to view directory lists.

Request samples
application/json
{
  • "platformSettingSamlIdentityProviderCertificateExpiryWarningDays": {
    },
  • "platformSettingUpdateAgentSecurityOnMissingDeepSecurityManagerEnabled": {
    },
  • "platformSettingDdanManualSourceServerUrl": {
    },
  • "platformSettingSmartProtectionFeedbackThreatDetectionsThreshold": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterMedium": {
    },
  • "firewallSettingIntranetConnectivityTestExpectedContentRegex": {
    },
  • "platformSettingEventForwardingSnsEnabled": {
    },
  • "platformSettingTenantAutoRevokeImpersonationByPrimaryTenantTimeout": {
    },
  • "webReputationSettingEventRankRiskBlockedByAdministratorRank": {
    },
  • "antiMalwareSettingEventEmailRecipients": {
    },
  • "firewallSettingIntranetConnectivityTestUrl": {
    },
  • "platformSettingTenantUseDefaultRelayGroupFromPrimaryTenantEnabled": {
    },
  • "platformSettingExportedDiagnosticPackageLocale": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterCritical": {
    },
  • "platformSettingTrendMicroXdrCommonLogReceiverUrl": {
    },
  • "platformSettingManagedDetectResponseCompanyGuid": {
    },
  • "platformSettingAlertDefaultEmailAddress": {
    },
  • "platformSettingAgentInitiatedActivationReactivateClonedEnabled": {
    },
  • "platformSettingManagedDetectResponseServerUrl": {
    },
  • "platformSettingSyslogConfigId": {
    },
  • "platformSettingSmtpStartTlsEnabled": {
    },
  • "platformSettingUserPasswordRequireLettersAndNumbersEnabled": {
    },
  • "platformSettingManagedDetectResponseEnabled": {
    },
  • "platformSettingUpdateRulesPolicyAutoApplyEnabled": {
    },
  • "platformSettingUserPasswordRequireNotSameAsUsernameEnabled": {
    },
  • "logInspectionSettingEventRankSeverityMedium": {
    },
  • "antiMalwareSettingRetainEventDuration": {
    },
  • "platformSettingUpdateAgentSecurityContactPrimarySourceOnMissingRelayEnabled": {
    },
  • "firewallSettingEventRankSeverityLogOnly": {
    },
  • "applicationControlSettingRetainEventDuration": {
    },
  • "platformSettingWindowsUpgradeOnActivationEnabled": {
    },
  • "platformSettingSystemEventForwardingSnmpPort": {
    },
  • "firewallSettingEventRankSeverityDeny": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterLow": {
    },
  • "platformSettingManagedDetectResponseServiceToken": {
    },
  • "platformSettingSolutionCenterActivationDiagnosticPackage": {
    },
  • "platformSettingTrendMicroXdrApiUser": {
    },
  • "logInspectionSettingRetainEventDuration": {
    },
  • "platformSettingTenantAutoRevokeImpersonationByPrimaryTenantEnabled": {
    },
  • "antiMalwareSettingEventEmailBodyTemplate": {
    },
  • "platformSettingRetainSecurityUpdatesMax": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerSourceOption": {
    },
  • "antiMalwareSettingEventEmailEnabled": {
    },
  • "platformSettingRecommendationOngoingScansEnabled": {
    },
  • "platformSettingUserPasswordLengthMin": {
    },
  • "platformSettingAwsManagerIdentityUseInstanceRoleEnabled": {
    },
  • "platformSettingAlertAgentUpdatePendingThreshold": {
    },
  • "platformSettingUserPasswordRequireSpecialCharactersEnabled": {
    },
  • "deviceControlSettingRetainEventDuration": {
    },
  • "platformSettingUpdateApplianceDefaultAgentVersion": {
    },
  • "platformSettingSystemEventForwardingSnmpEnabled": {
    },
  • "platformSettingSmtpBounceEmailAddress": {
    },
  • "platformSettingUpdateRelaySecuritySupportAgent9AndEarlierEnabled": {
    },
  • "platformSettingManagedDetectResponseProxyId": {
    },
  • "platformSettingTrendMicroXdrLogServerUrl": {
    },
  • "platformSettingInactiveAgentCleanupEnabled": {
    },
  • "platformSettingUserSessionIdleTimeout": {
    },
  • "antiMalwareSettingEventEmailSubject": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerUseProxyEnabled": {
    },
  • "platformSettingAwsManagerIdentityAccessKey": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerProxyId": {
    },
  • "platformSettingTrendMicroXdrRegistrationState": {
    },
  • "platformSettingTenantAllowImpersonationByPrimaryTenantEnabled": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerManualSourceServerUrl": {
    },
  • "platformSettingUserPasswordRequireMixedCaseEnabled": {
    },
  • "platformSettingTrendMicroXdrIdentityProviderApiUrl": {
    },
  • "platformSettingSmartProtectionFeedbackForSuspiciousFileEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackIndustryType": {
    },
  • "webReputationSettingRetainEventDuration": {
    },
  • "platformSettingEnableAgentAutoDetectOsProxy": {
    },
  • "integrityMonitoringSettingEventRankSeverityMedium": {
    },
  • "platformSettingVisionOneThreatIntelligenceEnabled": {
    },
  • "platformSettingMacUpgradeOnActivationEnabled": {
    },
  • "platformSettingUpdateRelaySecurityAllRegionsPatternsDownloadEnabled": {
    },
  • "platformSettingDdanSubmissionEnabled": {
    },
  • "webReputationSettingEventRankRiskSuspicious": {
    },
  • "integrityMonitoringSettingEventRankSeverityCritical": {
    },
  • "platformSettingSmtpFromEmailAddress": {
    },
  • "firewallSettingGlobalStatefulConfigId": {
    },
  • "platformSettingEventForwardingSnsTopicArn": {
    },
  • "firewallSettingInternetConnectivityTestExpectedContentRegex": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerManualSourceApiKey": {
    },
  • "platformSettingUpdateSecurityPrimarySourceMode": {
    },
  • "webReputationSettingEventRankRiskDangerous": {
    },
  • "platformSettingUserHideUnlicensedModulesEnabled": {
    },
  • "platformSettingCaptureEncryptedTrafficEnabled": {
    },
  • "platformSettingRetainSystemEventDuration": {
    },
  • "platformSettingUserPasswordExpiry": {
    },
  • "platformSettingSmartProtectionFeedbackEnabled": {
    },
  • "integrityMonitoringSettingRetainEventDuration": {
    },
  • "logInspectionSettingEventRankSeverityCritical": {
    },
  • "platformSettingDdanProxyId": {
    },
  • "platformSettingAgentInitiatedActivationWithinIpListId": {
    },
  • "platformSettingUpdateSecurityPrimarySourceUrl": {
    },
  • "platformSettingAgentlessVcloudProtectionEnabled": {
    },
  • "platformSettingLinuxUpgradeOnActivationEnabled": {
    },
  • "platformSettingTrendMicroXdrEnabled": {
    },
  • "platformSettingActiveSessionsMaxExceededAction": {
    },
  • "platformSettingUpdateHostnameOnIpChangeEnabled": {
    },
  • "logInspectionSettingEventRankSeverityHigh": {
    },
  • "platformSettingSmtpRequiresAuthenticationEnabled": {
    },
  • "platformSettingActiveSessionsMax": {
    },
  • "platformSettingAwsExternalIdRetrievalEnabled": {
    },
  • "logInspectionSettingEventRankSeverityLow": {
    },
  • "platformSettingSmtpUsername": {
    },
  • "platformSettingXdrEnrolledVia": {
    },
  • "platformSettingEventForwardingSnsAdvancedConfigEnabled": {
    },
  • "firewallSettingInternetConnectivityTestInterval": {
    },
  • "platformSettingWhoisUrl": {
    },
  • "platformSettingDdanSourceOption": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerSuspiciousObjectListComparisonEnabled": {
    },
  • "platformSettingExportedFileCharacterEncoding": {
    },
  • "platformSettingUserSessionDurationMax": {
    },
  • "platformSettingUpdateSoftwareAlternateUpdateServerUrls": {
    },
  • "platformSettingRetainCountersDuration": {
    },
  • "platformSettingUpdateAgentSecurityPrimarySourceOnEdgeRelayEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackInterval": {
    },
  • "platformSettingSystemEventForwardingSnmpAddress": {
    },
  • "platformSettingSmtpServerAddress": {
    },
  • "platformSettingSmtpPassword": {
    },
  • "platformSettingEventForwardingSnsConfigJson": {
    },
  • "firewallSettingRetainEventDuration": {
    },
  • "webReputationSettingEventRankRiskUntested": {
    },
  • "platformSettingManagedDetectResponseUseProxyEnabled": {
    },
  • "platformSettingEventForwardingSnsSecretKey": {
    },
  • "platformSettingAwsManagerIdentitySecretKey": {
    },
  • "webReputationSettingEventRankRiskHighlySuspicious": {
    },
  • "platformSettingUserPasswordExpirySendEmailEnabled": {
    },
  • "platformSettingUserSignInAttemptsAllowedNumber": {
    },
  • "platformSettingAgentInitiatedActivationSupportVirtualDesktopInfrastructure": {
    },
  • "platformSettingDdanUseProxyEnabled": {
    },
  • "platformSettingOverwriteHostnameDuringHeartbeatEnabled": {
    },
  • "platformSettingAgentInitiatedActivationEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackBandwidthMaxKbytes": {
    },
  • "firewallSettingEventRankSeverityPacketRejection": {
    },
  • "platformSettingManagedDetectResponseUsePrimaryTenantSettingsEnabled": {
    },
  • "platformSettingEventForwardingSnsAccessKey": {
    },
  • "platformSettingAgentInitiatedActivationSpecifyHostnameEnabled": {
    },
  • "platformSettingConnectedThreatDefensesUsePrimaryTenantServerSettingsEnabled": {
    },
  • "platformSettingInactiveAgentCleanupDuration": {
    },
  • "platformSettingAgentInitiatedActivationDuplicateHostnameMode": {
    },
  • "platformSettingAllowPacketDataCaptureInNetworkEvents": {
    },
  • "platformSettingAgentInitiatedActivationReactivateUnknownEnabled": {
    },
  • "platformSettingAgentInitiatedActivationPolicyId": {
    },
  • "platformSettingTrendMicroXdrApiServerUrl": {
    },
  • "platformSettingRetainAgentInstallersPerPlatformMax": {
    },
  • "applicationControlSettingServeRulesetsFromRelaysEnabled": {
    },
  • "integrityMonitoringSettingEventRankSeverityHigh": {
    },
  • "platformSettingSamlRetainInactiveExternalAdministratorsDuration": {
    },
  • "intrusionPreventionSettingRetainEventDuration": {
    },
  • "firewallSettingInternetConnectivityTestUrl": {
    },
  • "platformSettingProxyAgentUpdateProxyId": {
    },
  • "platformSettingDdanAutoSubmissionEnabled": {
    },
  • "platformSettingDdanManualSourceApiKey": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterError": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterHigh": {
    },
  • "platformSettingTrendMicroXdrApiKey": {
    },
  • "platformSettingCloudOneWorkloadSecurityIocEnabled": {
    },
  • "integrityMonitoringSettingEventRankSeverityLow": {
    },
  • "platformSettingTrendMicroXdrCompanyId": {
    }
}
Response samples
application/json
{
  • "platformSettingSamlIdentityProviderCertificateExpiryWarningDays": {
    },
  • "platformSettingUpdateAgentSecurityOnMissingDeepSecurityManagerEnabled": {
    },
  • "platformSettingDdanManualSourceServerUrl": {
    },
  • "platformSettingSmartProtectionFeedbackThreatDetectionsThreshold": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterMedium": {
    },
  • "firewallSettingIntranetConnectivityTestExpectedContentRegex": {
    },
  • "platformSettingEventForwardingSnsEnabled": {
    },
  • "platformSettingTenantAutoRevokeImpersonationByPrimaryTenantTimeout": {
    },
  • "webReputationSettingEventRankRiskBlockedByAdministratorRank": {
    },
  • "antiMalwareSettingEventEmailRecipients": {
    },
  • "firewallSettingIntranetConnectivityTestUrl": {
    },
  • "platformSettingTenantUseDefaultRelayGroupFromPrimaryTenantEnabled": {
    },
  • "platformSettingExportedDiagnosticPackageLocale": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterCritical": {
    },
  • "platformSettingTrendMicroXdrCommonLogReceiverUrl": {
    },
  • "platformSettingManagedDetectResponseCompanyGuid": {
    },
  • "platformSettingAlertDefaultEmailAddress": {
    },
  • "platformSettingAgentInitiatedActivationReactivateClonedEnabled": {
    },
  • "platformSettingManagedDetectResponseServerUrl": {
    },
  • "platformSettingSyslogConfigId": {
    },
  • "platformSettingSmtpStartTlsEnabled": {
    },
  • "platformSettingUserPasswordRequireLettersAndNumbersEnabled": {
    },
  • "platformSettingManagedDetectResponseEnabled": {
    },
  • "platformSettingUpdateRulesPolicyAutoApplyEnabled": {
    },
  • "platformSettingUserPasswordRequireNotSameAsUsernameEnabled": {
    },
  • "logInspectionSettingEventRankSeverityMedium": {
    },
  • "antiMalwareSettingRetainEventDuration": {
    },
  • "platformSettingUpdateAgentSecurityContactPrimarySourceOnMissingRelayEnabled": {
    },
  • "firewallSettingEventRankSeverityLogOnly": {
    },
  • "applicationControlSettingRetainEventDuration": {
    },
  • "platformSettingWindowsUpgradeOnActivationEnabled": {
    },
  • "platformSettingSystemEventForwardingSnmpPort": {
    },
  • "firewallSettingEventRankSeverityDeny": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterLow": {
    },
  • "platformSettingManagedDetectResponseServiceToken": {
    },
  • "platformSettingSolutionCenterActivationDiagnosticPackage": {
    },
  • "platformSettingTrendMicroXdrApiUser": {
    },
  • "logInspectionSettingRetainEventDuration": {
    },
  • "platformSettingTenantAutoRevokeImpersonationByPrimaryTenantEnabled": {
    },
  • "antiMalwareSettingEventEmailBodyTemplate": {
    },
  • "platformSettingRetainSecurityUpdatesMax": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerSourceOption": {
    },
  • "antiMalwareSettingEventEmailEnabled": {
    },
  • "platformSettingRecommendationOngoingScansEnabled": {
    },
  • "platformSettingUserPasswordLengthMin": {
    },
  • "platformSettingAwsManagerIdentityUseInstanceRoleEnabled": {
    },
  • "platformSettingAlertAgentUpdatePendingThreshold": {
    },
  • "platformSettingUserPasswordRequireSpecialCharactersEnabled": {
    },
  • "deviceControlSettingRetainEventDuration": {
    },
  • "platformSettingUpdateApplianceDefaultAgentVersion": {
    },
  • "platformSettingSystemEventForwardingSnmpEnabled": {
    },
  • "platformSettingSmtpBounceEmailAddress": {
    },
  • "platformSettingUpdateRelaySecuritySupportAgent9AndEarlierEnabled": {
    },
  • "platformSettingManagedDetectResponseProxyId": {
    },
  • "platformSettingTrendMicroXdrLogServerUrl": {
    },
  • "platformSettingInactiveAgentCleanupEnabled": {
    },
  • "platformSettingUserSessionIdleTimeout": {
    },
  • "antiMalwareSettingEventEmailSubject": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerUseProxyEnabled": {
    },
  • "platformSettingAwsManagerIdentityAccessKey": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerProxyId": {
    },
  • "platformSettingTrendMicroXdrRegistrationState": {
    },
  • "platformSettingTenantAllowImpersonationByPrimaryTenantEnabled": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerManualSourceServerUrl": {
    },
  • "platformSettingUserPasswordRequireMixedCaseEnabled": {
    },
  • "platformSettingTrendMicroXdrIdentityProviderApiUrl": {
    },
  • "platformSettingSmartProtectionFeedbackForSuspiciousFileEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackIndustryType": {
    },
  • "webReputationSettingRetainEventDuration": {
    },
  • "platformSettingEnableAgentAutoDetectOsProxy": {
    },
  • "integrityMonitoringSettingEventRankSeverityMedium": {
    },
  • "platformSettingVisionOneThreatIntelligenceEnabled": {
    },
  • "platformSettingMacUpgradeOnActivationEnabled": {
    },
  • "platformSettingUpdateRelaySecurityAllRegionsPatternsDownloadEnabled": {
    },
  • "platformSettingDdanSubmissionEnabled": {
    },
  • "webReputationSettingEventRankRiskSuspicious": {
    },
  • "integrityMonitoringSettingEventRankSeverityCritical": {
    },
  • "platformSettingSmtpFromEmailAddress": {
    },
  • "firewallSettingGlobalStatefulConfigId": {
    },
  • "platformSettingEventForwardingSnsTopicArn": {
    },
  • "firewallSettingInternetConnectivityTestExpectedContentRegex": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerManualSourceApiKey": {
    },
  • "platformSettingUpdateSecurityPrimarySourceMode": {
    },
  • "webReputationSettingEventRankRiskDangerous": {
    },
  • "platformSettingUserHideUnlicensedModulesEnabled": {
    },
  • "platformSettingCaptureEncryptedTrafficEnabled": {
    },
  • "platformSettingRetainSystemEventDuration": {
    },
  • "platformSettingUserPasswordExpiry": {
    },
  • "platformSettingSmartProtectionFeedbackEnabled": {
    },
  • "integrityMonitoringSettingRetainEventDuration": {
    },
  • "logInspectionSettingEventRankSeverityCritical": {
    },
  • "platformSettingDdanProxyId": {
    },
  • "platformSettingAgentInitiatedActivationWithinIpListId": {
    },
  • "platformSettingUpdateSecurityPrimarySourceUrl": {
    },
  • "platformSettingAgentlessVcloudProtectionEnabled": {
    },
  • "platformSettingLinuxUpgradeOnActivationEnabled": {
    },
  • "platformSettingTrendMicroXdrEnabled": {
    },
  • "platformSettingActiveSessionsMaxExceededAction": {
    },
  • "platformSettingUpdateHostnameOnIpChangeEnabled": {
    },
  • "logInspectionSettingEventRankSeverityHigh": {
    },
  • "platformSettingSmtpRequiresAuthenticationEnabled": {
    },
  • "platformSettingActiveSessionsMax": {
    },
  • "platformSettingAwsExternalIdRetrievalEnabled": {
    },
  • "logInspectionSettingEventRankSeverityLow": {
    },
  • "platformSettingSmtpUsername": {
    },
  • "platformSettingXdrEnrolledVia": {
    },
  • "platformSettingEventForwardingSnsAdvancedConfigEnabled": {
    },
  • "firewallSettingInternetConnectivityTestInterval": {
    },
  • "platformSettingWhoisUrl": {
    },
  • "platformSettingDdanSourceOption": {
    },
  • "platformSettingConnectedThreatDefenseControlManagerSuspiciousObjectListComparisonEnabled": {
    },
  • "platformSettingExportedFileCharacterEncoding": {
    },
  • "platformSettingUserSessionDurationMax": {
    },
  • "platformSettingUpdateSoftwareAlternateUpdateServerUrls": {
    },
  • "platformSettingRetainCountersDuration": {
    },
  • "platformSettingUpdateAgentSecurityPrimarySourceOnEdgeRelayEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackInterval": {
    },
  • "platformSettingSystemEventForwardingSnmpAddress": {
    },
  • "platformSettingSmtpServerAddress": {
    },
  • "platformSettingSmtpPassword": {
    },
  • "platformSettingEventForwardingSnsConfigJson": {
    },
  • "firewallSettingRetainEventDuration": {
    },
  • "webReputationSettingEventRankRiskUntested": {
    },
  • "platformSettingManagedDetectResponseUseProxyEnabled": {
    },
  • "platformSettingEventForwardingSnsSecretKey": {
    },
  • "platformSettingAwsManagerIdentitySecretKey": {
    },
  • "webReputationSettingEventRankRiskHighlySuspicious": {
    },
  • "platformSettingUserPasswordExpirySendEmailEnabled": {
    },
  • "platformSettingUserSignInAttemptsAllowedNumber": {
    },
  • "platformSettingAgentInitiatedActivationSupportVirtualDesktopInfrastructure": {
    },
  • "platformSettingDdanUseProxyEnabled": {
    },
  • "platformSettingOverwriteHostnameDuringHeartbeatEnabled": {
    },
  • "platformSettingAgentInitiatedActivationEnabled": {
    },
  • "platformSettingSmartProtectionFeedbackBandwidthMaxKbytes": {
    },
  • "firewallSettingEventRankSeverityPacketRejection": {
    },
  • "platformSettingManagedDetectResponseUsePrimaryTenantSettingsEnabled": {
    },
  • "platformSettingEventForwardingSnsAccessKey": {
    },
  • "platformSettingAgentInitiatedActivationSpecifyHostnameEnabled": {
    },
  • "platformSettingConnectedThreatDefensesUsePrimaryTenantServerSettingsEnabled": {
    },
  • "platformSettingInactiveAgentCleanupDuration": {
    },
  • "platformSettingAgentInitiatedActivationDuplicateHostnameMode": {
    },
  • "platformSettingAllowPacketDataCaptureInNetworkEvents": {
    },
  • "platformSettingAgentInitiatedActivationReactivateUnknownEnabled": {
    },
  • "platformSettingAgentInitiatedActivationPolicyId": {
    },
  • "platformSettingTrendMicroXdrApiServerUrl": {
    },
  • "platformSettingRetainAgentInstallersPerPlatformMax": {
    },
  • "applicationControlSettingServeRulesetsFromRelaysEnabled": {
    },
  • "integrityMonitoringSettingEventRankSeverityHigh": {
    },
  • "platformSettingSamlRetainInactiveExternalAdministratorsDuration": {
    },
  • "intrusionPreventionSettingRetainEventDuration": {
    },
  • "firewallSettingInternetConnectivityTestUrl": {
    },
  • "platformSettingProxyAgentUpdateProxyId": {
    },
  • "platformSettingDdanAutoSubmissionEnabled": {
    },
  • "platformSettingDdanManualSourceApiKey": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterError": {
    },
  • "intrusionPreventionSettingEventRankSeverityFilterHigh": {
    },
  • "platformSettingTrendMicroXdrApiKey": {
    },
  • "platformSettingCloudOneWorkloadSecurityIocEnabled": {
    },
  • "integrityMonitoringSettingEventRankSeverityLow": {
    },
  • "platformSettingTrendMicroXdrCompanyId": {
    }
}

Describe a System Setting

get/systemsettings/{name}

Return the value for a system setting.

Related SDK Methods:
Java

SystemSettingsApi.describeSystemSetting([param1, param2, ...])
Python

SystemSettingsApi.describe_system_setting([param1, param2, ...])
JavaScript

SystemSettingsApi.describeSystemSetting([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
name
required
string

The name of the system setting.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view settings.

404

The setting does not exist.

Request samples
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.SystemSettingsApi;
import com.trendmicro.deepsecurity.model.SettingValue;


public class DescribeSystemSettingExample {
	
	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
		SystemSettingsApi instance = new SystemSettingsApi();
		String name = "name_example";
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SettingValue result = instance.describeSystemSetting(name, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SystemSettingsApi.describeSystemSetting");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "value": "string"
}

Modify a System Setting

post/systemsettings/{name}

Modify the value for a system setting.

Related SDK Methods:
Java

SystemSettingsApi.modifySystemSetting([param1, param2, ...])
Python

SystemSettingsApi.modify_system_setting([param1, param2, ...])
JavaScript

SystemSettingsApi.modifySystemSetting([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
name
required
string

The name of the setting.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The new value for the setting setting.

value
string

Value of a Setting.

Responses
200

successful operation

403

Not authorized to modify settings or the requested modification is not permitted.

404

The setting does not exist.

Request samples
application/json
{
  • "value": "string"
}
Response samples
application/json
{
  • "value": "string"
}

Reset a System Setting

delete/systemsettings/{name}

Reset the value for a system setting.

Related SDK Methods:
Java

SystemSettingsApi.resetSystemSetting([param1, param2, ...])
Python

SystemSettingsApi.reset_system_setting([param1, param2, ...])
JavaScript

SystemSettingsApi.resetSystemSetting([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
name
required
string

The name of the system setting.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to modify settings or the requested modification is not permitted.

404

The setting does not exist.

Request samples
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.SystemSettingsApi;
import com.trendmicro.deepsecurity.model.SettingValue;


public class ResetSystemSettingExample {
	
	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
		SystemSettingsApi instance = new SystemSettingsApi();
		String name = "name_example";
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SettingValue result = instance.resetSystemSetting(name, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SystemSettingsApi.resetSystemSetting");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "value": "string"
}
➔ Next to Syslog Configurations