Global Rules

Describe a global rule

get/applicationcontrolglobalrules/{ruleID}

Describe a global rule by ID.

Related SDK Methods:

Java

GlobalRulesApi.describeGlobalRule([param1, param2, ...])

Python

GlobalRulesApi.describe_global_rule([param1, param2, ...])

JavaScript

GlobalRulesApi.describeGlobalRule([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

ruleID

required

integer <int64> \d+

The ID number of the rule to describe.

Example: 1

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 global rules

404

The rule does not exist.

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.GlobalRulesApi;
import com.trendmicro.deepsecurity.model.ApplicationControlGlobalRule;


public class DescribeGlobalRuleExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		GlobalRulesApi instance = new GlobalRulesApi();
		Long ruleID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationControlGlobalRule result = instance.describeGlobalRule(ruleID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GlobalRulesApi.describeGlobalRule");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string",
"action": "block",
"lastUpdatedAdministrator": 0,
"lastUpdated": 0,
"ID": 0
}

Modify a global rule

post/applicationcontrolglobalrules/{ruleID}

Modify a global rule by ID. Any unset elements will be left unchanged.

Related SDK Methods:

Java

GlobalRulesApi.modifyGlobalRule([param1, param2, ...])

Python

GlobalRulesApi.modify_global_rule([param1, param2, ...])

JavaScript

GlobalRulesApi.modifyGlobalRule([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

ruleID

required

integer <int64> \d+

The ID number of the rule to modify.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The settings of the rule to be modified.

description	string Description of the rule. Searchable as String.
md5	string MD5 hash of the executable named in the rule. Searchable as String.
sha1	string SHA-1 hash of the executable named in the rule. Searchable as String.
sha256	string SHA-256 hash of the executable named in the rule. Searchable as String.

Responses

200

successful operation

403

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

404

The rule does not exist.

Request samples

Payload
Java
Python
JavaScript

application/json

{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string"
}

Response samples

application/json

{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string",
"action": "block",
"lastUpdatedAdministrator": 0,
"lastUpdated": 0,
"ID": 0
}

Delete a global rule

delete/applicationcontrolglobalrules/{ruleID}

Delete a global rule by ID.

Related SDK Methods:

Java

GlobalRulesApi.deleteGlobalRule([param1, param2, ...])

Python

GlobalRulesApi.delete_global_rule([param1, param2, ...])

JavaScript

GlobalRulesApi.deleteGlobalRule([param1, param2, ...])

Request

Security:

DefaultAuthentication

path Parameters

ruleID

required

integer <int64> \d+

The ID number of the rule to delete.

Example: 1

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Responses

200

Request is successful.

204

Request is successful.

403

Not authorized to delete rules.

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.GlobalRulesApi;


public class DeleteGlobalRuleExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		GlobalRulesApi instance = new GlobalRulesApi();
		Long ruleID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteGlobalRule(ruleID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GlobalRulesApi.deleteGlobalRule");
			e.printStackTrace();
		}
	}
}

List all global rules

get/applicationcontrolglobalrules

List all global rules.

Related SDK Methods:

Java

GlobalRulesApi.listGlobalRules([param1, param2, ...])

Python

GlobalRulesApi.list_global_rules([param1, param2, ...])

JavaScript

GlobalRulesApi.listGlobalRules([param1, param2, ...])

Request

Security:

DefaultAuthentication

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 global rules

Request samples

Java
Python
JavaScript

import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.GlobalRulesApi;
import com.trendmicro.deepsecurity.model.ApplicationControlGlobalRules;


public class ListGlobalRulesExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth DefaultAuthentication = (ApiKeyAuth) defaultClient.getAuthentication("DefaultAuthentication");
		DefaultAuthentication.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
		GlobalRulesApi instance = new GlobalRulesApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			ApplicationControlGlobalRules result = instance.listGlobalRules(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GlobalRulesApi.listGlobalRules");
			e.printStackTrace();
		}
	}
}

Response samples

application/json

{"applicationControlGlobalRules": [{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string",
"action": "block",
"lastUpdatedAdministrator": 0,
"lastUpdated": 0,
"ID": 0
}
]
}

Create and add new global rules

post/applicationcontrolglobalrules

Create and add global rules.

Related SDK Methods:

Java

GlobalRulesApi.addGlobalRules([param1, param2, ...])

Python

GlobalRulesApi.add_global_rules([param1, param2, ...])

JavaScript

GlobalRulesApi.addGlobalRules([param1, param2, ...])

Request

Security:

DefaultAuthentication

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

The settings of the new rules.

Array of objects (applicationControlGlobalRule)

Responses

200

successful operation

403

Not authorized to add global rules.

Request samples

Payload
Java
Python
JavaScript

application/json

{"applicationControlGlobalRules": [{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string"
}
]
}

Response samples

application/json

{"applicationControlGlobalRules": [{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string",
"action": "block",
"lastUpdatedAdministrator": 0,
"lastUpdated": 0,
"ID": 0
}
]
}

Search global rules

post/applicationcontrolglobalrules/search

Search for global rules using optional filters.

Related SDK Methods:

Java

GlobalRulesApi.searchGlobalRules([param1, param2, ...])

Python

GlobalRulesApi.search_global_rules([param1, param2, ...])

JavaScript

GlobalRulesApi.searchGlobalRules([param1, param2, ...])

Request

Security:

DefaultAuthentication

header Parameters

api-version

required

string

The version of the api being called.

Example: YOUR VERSION

Request Body schema: application/json

A collection of options used to filter the search results.

maxItems	integer <int32> Limits the number of objects returned. Default 5000.
	Array of objects (searchCriteria) Array of search critiera used to filter objects. Searching with multiple criteria returns results that satisfy all of the criteria. Searching with no criteria returns all objects.
sortByObjectID	boolean If true, forces the response objects to be sorted by ID, overriding the default sort order. Default "false".

Responses

200

successful operation

403

Not authorized to view global rules

Request samples

Payload
Java
Python
JavaScript

application/json

{"maxItems": 0,
"searchCriteria": [{"fieldName": "string",
"booleanTest": true,
"numericTest": "less-than",
"numericValue": 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"
}
],
"sortByObjectID": true
}

Response samples

application/json

{"applicationControlGlobalRules": [{"sha256": "string",
"sha1": "string",
"md5": "string",
"description": "string",
"action": "block",
"lastUpdatedAdministrator": 0,
"lastUpdated": 0,
"ID": 0
}
]
}

➔ Next to Rulesets