Views:

Last Updated: 1/22/2020 12:10:58 AM

Update global settings for customers.

1. If customers specified, it will only update their global settings.

2. Otherwise, it will update for all your 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 comma.

At least one customer ID must be specified, and no more than 10. This field will become required, if sync is set true.

sync

boolean

Set whether to process the update synchronously.

If not set, the default is false. However, if set true, cids will become 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

Specify the password which the client user will be required to enter to exit the Security Agent.

global_setting.agent_uninstall.password_required

integer

Allow the client user to exit the Security Agent without a password.

1 = true; 0 = false

global_setting.agent_unload.password

string

Specify the password which the client user will be required to enter a password to uninstall the Security Agent.

global_setting.agent_unload.password_required

integer

Allow the client user to uninstall the Security Agent without a password.

1 = true; 0 = false

global_setting.alert.pattern_outdated_days

integer

If the virus pattern file is not updated after the number of days specified, the alert icon on the Windows taskbar should be shown.

global_setting.alert.show_alert_icon

integer

Show the alert icon on the Windows taskbar if the virus pattern file is not updated after a certain number of days.

1 = true; 0 = false

global_setting.approved_url.agent_usage_logs

integer

Send the Agent Web Reputation and URL Filtering log to the server.

1 = true; 0 = false

global_setting.approved_url.urls[]

string

Approved URL for Web Reputation and URL Filtering

e.g., http://www.trendmicro.com/*

global_setting.auto_cleanup.enabled

integer

Enable automatic agent removal.

1 = true; 0 = false

global_setting.auto_cleanup.threshold

integer

After the maximum disconnection period (in days) specified, the device will be automatically removed.

global_setting.behavior_monitoring.enable_warning_low_risk

integer

Enable warning messages for low-risk changes or other monitored actions.

1 = true; 0 = false

global_setting.behavior_monitoring.prompt_before_execute_downloaded_file

integer

Prompt users before executing newly encountered programs downloaded through HTTP or email applications (Server platforms excluded)

1 = true; 0 = false

global_setting.blocked_url.blocked_urls[]

string

Blocked URL for URL Filtering

e.g., http://www.blocked.com/*

global_setting.general_scan.deferred_scan_on_file_operation

integer

Enable deferred scanning on file operations

1 = true; 0 = false

global_setting.general_scan.exclude_domain_controller

integer

Exclude Microsoft Domain Controller folders.

1 = true; 0 = false

global_setting.general_scan.exclude_exchange_server

integer

Exclude Microsoft Exchange server folders when installed on Microsoft Exchange server.

1 = true; 0 = false

global_setting.general_scan.exclude_shadow_copy

integer

Exclude Shadow Copy sections.

1 = true; 0 = false

global_setting.general_scan.schedule_scan_resume

integer

Resume a missed scheduled scan at the same time next day.

1 = true; 0 = false

global_setting.help_desk.enabled

integer

Display Help Desk information on the agent.

1 = true; 0 = false

global_setting.help_desk.info

string

Hover-over text

global_setting.help_desk.label

string

Help Desk label

global_setting.help_desk.mail

string

Help Desk email address

global_setting.magic_link_expire.enabled

integer

Enable Agent Installation Link expiry.

1 = true; 0 = false

global_setting.magic_link_expire.threshold

integer

Specify the duration (in days) of Agent Installation Link expiry.

global_setting.outbreak_defense.red_alert.enable

integer

Enable Red Alerts issued by Trend Micro.

1 = true; 0 = false

global_setting.outbreak_defense.yellow_alert.enable

integer

Enable Yellow Alerts issued by Trend Micro.

1 = true; 0 = false

global_setting.spyware_grayware.log_spyware_cookie_detection

integer

Add cookie detections to the Spyware log.

1 = true; 0 = false

global_setting.spyware_grayware.scan_cookies

integer

Scan for cookies.

1 = true; 0 = false

global_setting.user_centric.enabled

integer

Enable device labeling,

1 = true; 0 = false

global_setting.user_centric.label

string

Provide the owner label format.

global_setting.virus_scan.clean_compressed

integer

Clean compressed files.

1 = true; 0 = false

global_setting.virus_scan.enable_max_ole_layers

integer

Scan the OLE layers of compressed files.

1 = true; 0 = false

global_setting.virus_scan.max_ole_layers_to_scan

integer

The max number of theOLE layers that Agent will scan.

global_setting.virus_scan.max_size_compressed

integer

The maximum size (in megabyte) of the extracted file in the compressed file that Agent should scan.

global_setting.virus_scan.scan_first_n_files

integer

The number of files in the compressed file that Agent should scan.

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

Add Manual Scan to the Windows shortcut menu on clients

1 = true; 0 = false

global_setting.watchdog.agent_watchdog_service

integer

Set wether to enable the Client/Server Security Agent Watchdog service.

1 = true; 0 = false

global_setting.watchdog.check_interval

integer

Determines how often (in minutes) to check Agent status.

global_setting.watchdog.retry_to_start

integer

Determines the number of retry times, if Agent cannot be started.

replicate_from.cid

string

The source customer of global settings for replications.

GUID

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 gobal settings.

GUID

task.status

string

The status of the asynchronous task to update gobal settings.

PENDING, STARTED, SUCCESS, FAILURE, or REVOKED