Last Updated: 1/22/2020 12:11:17 AM
Update global settings for a specific customer. If no customer is specified, the updates affect all customers.
Request
HTTP Request
PUT /SMPI/{version}/service/wfbss/api/global_settings
Parameters
Name |
Type |
Description |
Validation |
---|---|---|---|
Optional Parameters |
|||
cids |
string |
A list of customer IDs separated by commas |
At least one customer ID must be specified (maximum of 10) This field is required, if sync is set to "true". |
sync |
boolean |
Determines whether to process the update synchronously |
Default: False If set to "true", the cids value is required. |
HTTP Request Example
Asynchronously update global settings for all your customers: PUT /SMPI/{version}/service/wfbss/api/global_settings Asynchronously update global settings for specific customers: PUT /SMPI/{version}/service/wfbss/api/global_settings?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3 Synchronously update global settings for specific customers: PUT /SMPI/{version}/service/wfbss/api/global_settings?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3&sync=true
Request Body
1. You only need to send the setting fields that you want to update: { "global_setting": { "blocked_url": { "blocked_urls": [ "http://www.blocked-url.com/* " ] }, "approved_url": { "urls": [ "http://www.approved-url-1.com/*", "http://www.approved-url-1.com/*", "http://www.approved-url-1.com/*" ] } } } 2. You can replicate global settings from the other customer: { "replicate_from": { "cid": "A9CC5A34-3CAD-480D-A9ED-87656316D3B9" } }
Name |
Type |
Description |
Validation |
---|---|---|---|
global_setting.agent_uninstall.password |
string |
Specifies the password which the endpoint user must provide to uninstall the Security Agent. |
|
global_setting.agent_uninstall.password_required |
integer |
Specifies whether the endpoint user requires a password to uninstall the Security Agent. |
1 = true; 0 = false |
global_setting.agent_unload.password |
string |
Specifies the password which the endpoint user must provide to unload the Security Agent. |
|
global_setting.agent_unload.password_required |
integer |
Specifies whether the endpoint user requires a password to unload the Security Agent. |
1 = true; 0 = false |
global_setting.alert.pattern_outdated_days |
integer |
Specifies the outdated threshold (in days) of the virus pattern file. |
|
global_setting.alert.show_alert_icon |
integer |
Specifies whether the Security Agent displays the alert icon on the Windows taskbar if the virus pattern file is not updated according to the configured threshold. |
1 = true; 0 = false |
global_setting.approved_url.agent_usage_logs |
integer |
Sends the Security Agent Web Reputation and URL Filtering logs to the server. |
1 = true; 0 = false |
global_setting.approved_url.urls[] |
string |
Specifies an Approved URL for Web Reputation and URL Filtering |
e.g. http://www.trendmicro.com/* |
global_setting.auto_cleanup.enabled |
integer |
Enables automatic Security Agent removal from the device tree |
1 = true; 0 = false |
global_setting.auto_cleanup.threshold |
integer |
Specifies the inactivity threshold (in days) that determines whether to automatically remove an inactive endpoint from the device tree. |
|
global_setting.behavior_monitoring.enable_warning_low_risk |
integer |
Enables warning alerts for low-risk changes or other monitored actions. |
1 = true; 0 = false |
global_setting.behavior_monitoring.prompt_before_execute_downloaded_file |
integer |
Enables the "Prompt users before executing newly encountered programs downloaded through HTTP or email applications (Server platforms excluded)" function |
1 = true; 0 = false |
global_setting.blocked_url.blocked_urls[] |
string |
Specifies a Blocked URL for URL Filtering |
e.g., http://www.blocked.com/* |
global_setting.general_scan.deferred_scan_on_file_operation |
integer |
Enables deferred scanning on file operations |
1 = true; 0 = false |
global_setting.general_scan.exclude_domain_controller |
integer |
Excludes Microsoft Domain Controller folders |
1 = true; 0 = false |
global_setting.general_scan.exclude_exchange_server |
integer |
Excludes Microsoft Exchange server folders from scanning when installed on the Microsoft Exchange server |
1 = true; 0 = false |
global_setting.general_scan.exclude_shadow_copy |
integer |
Excludes Shadow Copy sections |
1 = true; 0 = false |
global_setting.general_scan.schedule_scan_resume |
integer |
Enables the "Resume a missed scheduled scan at the same time next day" function |
1 = true; 0 = false |
global_setting.help_desk.enabled |
integer |
Displays Help Desk information on the Security Agent console |
1 = true; 0 = false |
global_setting.help_desk.info |
string |
Specifies the hover-over text for the Help Desk button on the Security Agent console |
|
global_setting.help_desk.label |
string |
Specifies the Help Desk label text on the Security Agent console |
|
global_setting.help_desk.mail |
string |
Specifies the Help Desk email address |
|
global_setting.magic_link_expire.enabled |
integer |
Enables the Agent Installation Link expiry function |
1 = true; 0 = false |
global_setting.magic_link_expire.threshold |
integer |
Specifies the duration (in days) before the Agent Installation Link expires |
|
global_setting.outbreak_defense.red_alert.enable |
integer |
Enables Red Alerts issued by Trend Micro |
1 = true; 0 = false |
global_setting.outbreak_defense.yellow_alert.enable |
integer |
Enables Yellow Alerts issued by Trend Micro |
1 = true; 0 = false |
global_setting.spyware_grayware.log_spyware_cookie_detection |
integer |
Adds cookie detections to the Spyware log |
1 = true; 0 = false |
global_setting.spyware_grayware.scan_cookies |
integer |
Enables the "Scan for cookies" function |
1 = true; 0 = false |
global_setting.user_centric.enabled |
integer |
Enables device labeling |
1 = true; 0 = false |
global_setting.user_centric.label |
string |
Provides the owner label format |
|
global_setting.virus_scan.clean_compressed |
integer |
Enables "Clean compressed files" |
1 = true; 0 = false |
global_setting.virus_scan.enable_max_ole_layers |
integer |
Enables the "Scan the OLE layers of compressed files" function |
1 = true; 0 = false |
global_setting.virus_scan.max_ole_layers_to_scan |
integer |
Specifies the maximum number of OLE layers scanned |
|
global_setting.virus_scan.max_size_compressed |
integer |
Specifies the maximum size (in megabytes) of extracted files in compressed archives that the Security Agent scans |
|
global_setting.virus_scan.scan_first_n_files |
integer |
Specifies the maximum number of files to scan within compressed archives |
|
global_setting.virus_scan.scan_large_compressed |
integer |
Configure Scan Settings for large compressed files |
1 = true; 0 = false |
global_setting.virus_scan.shortcut_for_manual_scan |
integer |
Adds the "Manual Scan" item to the Windows shortcut menu on endpoints |
1 = true; 0 = false |
global_setting.watchdog.agent_watchdog_service |
integer |
Enables the Client/Server Security Agent Watchdog service |
1 = true; 0 = false |
global_setting.watchdog.check_interval |
integer |
Determines the frequency (in minutes) to check Security Agent status |
|
global_setting.watchdog.retry_to_start |
integer |
Determines the number of retry attempts on unresponsive Security Agents |
|
replicate_from.cid |
string |
Specifies the source customer for global setting replications |
GUID |
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
1. If parameter sync is set true, the response body is empty. 2. Otherwise, the reponse body is as below: { "task": { "status": "PENDING", "id": "0e41dc95-eb78-4dd3-9c1f-3bc47b915ab4" } }
Name |
Type |
Description |
Length |
---|---|---|---|
task.id |
string |
The ID of the asynchronous task to update global settings |
GUID |
task.status |
string |
The status of the asynchronous task to update global settings |
PENDING, STARTED, SUCCESS, FAILURE, or REVOKED |