Skip to main content

setPolicyModulesState

You can use this method to enable or disable the settings associated to a specific policy.

Parameters

Name

Description

Included in request

Type

Values

policyId

The ID of the policy you want to modify.

Mandatory

String

The user making the request must have the managePoliciesRead and managePoliciesWrite user rights for the company the target policy belongs to.

settings

The setting you want to modify.

Mandatory

Object

This object contains the settings that will be changed as a result of this request and their new values.

Objects

settings

Parameters

Important

All parameters under the settings object have specific prerequisites and requirements, which are documented in the linked KB article. Some of these requirements involve other settings, which are also available as parameters under the settings object.

If a setting depends on another setting being enabled, the following requirements must be met:

  • The required setting must either be enabled beforehand or be included in the request.

  • When writing the request, in the settings object, the required setting must be placed above (before) the dependent setting.

  • It must be given the enabled value.

Name

Description

Included in request

Type

antimalware.onAccess.onAccessScanning

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > On-access > On-access Scanning >.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.onExecute.cloudBasedThreatDetection

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > On-execute > On-execute Scanning > Cloud-based Threat Detection.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.onExecute.advancedThreatControl

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > On-execute > On-execute Scanning > Advanced Threat Control.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.onExecute.filelessAttackProtection

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > On-execute > On-execute Scanning > Fileless Attack Protection.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.onExecute.ransomwareMitigation

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > On-execute > On-execute Scanning > Ransomware Mitigation.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.antiTampering

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > Anti-Tampering > Anti-Tampering.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.hyperDetect

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > Hyper Detect > Hyper Detect.

Possible values:

  • enabled

  • disabled

Optional

String

antimalware.advancedAntiExploit

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Antimalware > Advanced Anti-Exploit > Advanced Anti-exploit.

Possible values:

  • enabled

  • disabled

Optional

String

firewall.general.firewall

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Firewall > General > Firewall.

Optional

String

firewall.general.ids

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Firewall > General > Intrusion Detection System (IDS).

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.general.networkProtection

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > General > Network Protection.

Optional

String

networkProtection.general.interceptEncryptedTraffic

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > General > Intercept Encrypted Traffic.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.general.scanHttps

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > General > Intercept Encrypted Traffic > Scan HTTPS.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.webProtection.antiphishing

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Web Protection > Antiphishing.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.webProtection.webTrafficScan

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Web Protection > Web Traffic Scan.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.networkAttacks.networkAttackDefense

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Network Attacks > Network Attack Defense.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.general.interceptTlsHandshake

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > General > Intercept Encrypted Traffic.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.webProtection.emailTrafficScan

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Web Protection > Email Traffic Scan.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.contentControl.webAccessControl

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Content Control > Web Access Control.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.contentControl.applicationBlacklist

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Content Control > Application Blacklist.

Possible values:

  • enabled

  • disabled

Optional

String

networkProtection.contentControl.dataProtection

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Network Protection > Content Control > Data Protection.

Possible values:

  • enabled

  • disabled

Optional

String

sandboxAnalyzer.endpointSensor.automaticSampleSubmissionFromManagedEndpoints

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Sandbox Analyzer > Endpoint Sensor > Automatic sample submission from managed endpoints.

Possible values:

  • enabled

  • disabled

Optional

String

encryption.general.encryption

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Encryption > General > Encryption.

Possible values:

  • enabled

  • disabled

Optional

String

incidentsSensor.general.incidentsSensor

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Incidents Sensor > General > Incidents Sensor.

Possible values:

  • enabled

  • disabled

Optional

String

blocklist.blocklist

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Blocklist > Blocklist.

Possible values:

  • enabled

  • disabled

Optional

String

blocklist.applicationHash

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Blocklist > Application hash.

Possible values:

  • enabled

  • disabled

Optional

String

blocklist.dllFiles

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Blocklist > DLL files.

Possible values:

  • enabled

  • disabled

Optional

String

blocklist.scriptFiles

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Blocklist > Script files.

Possible values:

  • enabled

  • disabled

Optional

String

blocklist.applicationPath

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Blocklist > Application path.

Possible values:

  • enabled

  • disabled

Optional

String

blocklist.networkConnection

The setting this parameter changes can be found in the GravityZone policy under Protection and monitoring > Blocklist > Network connection.

Possible values:

  • enabled

  • disabled

Optional

String

general.policy.details.allowOtherUsersToChangeThisPolicy

The setting this parameter changes can be found in the GravityZone policy under General > Details > Allow others to change this policy.

Possible values:

  • enabled

  • disabled

Optional

String

general.agent.notifications

The setting this parameter changes can be found in the GravityZone policy under General > Agent > Notifications > Notifications.

Possible values:

  • enabled

  • disabled

Optional

String

general.agent.update.productUpdate

The setting this parameter changes can be found in the GravityZone policy under General > Agent > Update > Product update.

Possible values:

  • enabled

  • disabled

Optional

String

general.agent.update.securityContentUpdate

The setting this parameter changes can be found in the GravityZone policy under General > Agent > Update > Security content update.

Possible values:

  • enabled

  • disabled

Optional

String

Return value

Attribute

Type

Description

result

Boolean

Indicates if the request was succesfull.

Example

Request:

{
      "params": {
          "policyId": "683ee75b6c9598ab03098f92",
          "settings": {
              "antimalware.onAccess.onAccessScanning": "enabled",
              "antimalware.onExecute.cloudBasedThreatDetection": "disabled",
              "antimalware.onExecute.advancedThreatControl": "disabled",
              "antimalware.onExecute.filelessAttackProtection": "enabled"

          }
      },
      "jsonrpc": "2.0",
      "method": "setPolicyModulesState",
      "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
}

Response:

{
    "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b",
    "jsonrpc":"2.0",
    "result": true
}
In this section: