keyboard_arrow_down
  • 12.0
  • 20.0

Policy Log Inspection Rule Assignments & Recommendations

List Log Inspection Rule IDs

get/policies/{policyID}/loginspection/assignments

Lists all log inspection rule IDs assigned to a policy.

Related SDK Methods:
Java

PolicyLogInspectionRuleAssignmentsRecommendationsApi.listLogInspectionRuleIDsOnPolicy([param1, param2, ...])
Python

PolicyLogInspectionRuleAssignmentsRecommendationsApi.list_log_inspection_rule_ids_on_policy([param1, param2, ...])
JavaScript

PolicyLogInspectionRuleAssignmentsRecommendationsApi.listLogInspectionRuleIDsOnPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Return only rule IDs assigned directly to the current policy.

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 the policy.

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


public class ListLogInspectionRuleIDsOnPolicyExample {
	
	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
		PolicyLogInspectionRuleAssignmentsRecommendationsApi instance = new PolicyLogInspectionRuleAssignmentsRecommendationsApi();
		Integer policyID = 1;
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			LogInspectionAssignments result = instance.listLogInspectionRuleIDsOnPolicy(policyID, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling PolicyLogInspectionRuleAssignmentsRecommendationsApi.listLogInspectionRuleIDsOnPolicy");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "assignedRuleIDs": [
    ],
  • "recommendationScanStatus": "none",
  • "lastRecommendationScanDate": 0,
  • "recommendedToAssignRuleIDs": [
    ],
  • "recommendedToUnassignRuleIDs": [
    ]
}

Add Log Inspection Rule IDs

post/policies/{policyID}/loginspection/assignments

Assign log inspection rule IDs to a policy.

Related SDK Methods:
Java

PolicyLogInspectionRuleAssignmentsRecommendationsApi.addLogInspectionRuleIDsToPolicy([param1, param2, ...])
Python

PolicyLogInspectionRuleAssignmentsRecommendationsApi.add_log_inspection_rule_ids_to_policy([param1, param2, ...])
JavaScript

PolicyLogInspectionRuleAssignmentsRecommendationsApi.addLogInspectionRuleIDsToPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Return only rule IDs assigned directly to the current policy.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The ID numbers of the log inspection rules to add.

ruleIDs
Array of integers <int32>
Responses
200

successful operation

403

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

404

The policy does not exist.

Request samples
application/json
{
  • "ruleIDs": [
    ]
}
Response samples
application/json
{
  • "assignedRuleIDs": [
    ],
  • "recommendationScanStatus": "none",
  • "lastRecommendationScanDate": 0,
  • "recommendedToAssignRuleIDs": [
    ],
  • "recommendedToUnassignRuleIDs": [
    ]
}

Set Log Inspection Rule IDs

put/policies/{policyID}/loginspection/assignments

Set log inspection rule IDs assigned to a policy.

Related SDK Methods:
Java

PolicyLogInspectionRuleAssignmentsRecommendationsApi.setLogInspectionRuleIDsOnPolicy([param1, param2, ...])
Python

PolicyLogInspectionRuleAssignmentsRecommendationsApi.set_log_inspection_rule_ids_on_policy([param1, param2, ...])
JavaScript

PolicyLogInspectionRuleAssignmentsRecommendationsApi.setLogInspectionRuleIDsOnPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Return only rule IDs assigned directly to the current policy.

header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The ID numbers of the log inspection rules to set.

ruleIDs
Array of integers <int32>
Responses
200

successful operation

403

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

404

The policy does not exist.

Request samples
application/json
{
  • "ruleIDs": [
    ]
}
Response samples
application/json
{
  • "assignedRuleIDs": [
    ],
  • "recommendationScanStatus": "none",
  • "lastRecommendationScanDate": 0,
  • "recommendedToAssignRuleIDs": [
    ],
  • "recommendedToUnassignRuleIDs": [
    ]
}

Remove a Log Inspection Rule ID

delete/policies/{policyID}/loginspection/assignments/{logInspectionRuleID}

Unassign a log inspection rule ID from a policy.

Related SDK Methods:
Java

PolicyLogInspectionRuleAssignmentsRecommendationsApi.removeLogInspectionRuleIDFromPolicy([param1, param2, ...])
Python

PolicyLogInspectionRuleAssignmentsRecommendationsApi.remove_log_inspection_rule_id_from_policy([param1, param2, ...])
JavaScript

PolicyLogInspectionRuleAssignmentsRecommendationsApi.removeLogInspectionRuleIDFromPolicy([param1, param2, ...])

Request
Security:
DefaultAuthentication
path Parameters
logInspectionRuleID
required
integer <int32> \d+

The ID number of the log inspection rule to delete.

Example: 1
policyID
required
integer <int32> \d+

The ID number of the policy.

Example: 1
query Parameters
overrides
boolean

Return only rule IDs assigned directly to the current policy.

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 the policy or the requested modification is not permitted.

404

The policy 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.ApiException;
import com.trendmicro.deepsecurity.api.PolicyLogInspectionRuleAssignmentsRecommendationsApi;
import com.trendmicro.deepsecurity.model.LogInspectionAssignments;


public class RemoveLogInspectionRuleIDFromPolicyExample {
	
	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
		PolicyLogInspectionRuleAssignmentsRecommendationsApi instance = new PolicyLogInspectionRuleAssignmentsRecommendationsApi();
		Integer policyID = 1;
		Integer logInspectionRuleID = 1;
		Boolean overrides = false;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			LogInspectionAssignments result = instance.removeLogInspectionRuleIDFromPolicy(policyID, logInspectionRuleID, overrides, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling PolicyLogInspectionRuleAssignmentsRecommendationsApi.removeLogInspectionRuleIDFromPolicy");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "assignedRuleIDs": [
    ],
  • "recommendationScanStatus": "none",
  • "lastRecommendationScanDate": 0,
  • "recommendedToAssignRuleIDs": [
    ],
  • "recommendedToUnassignRuleIDs": [
    ]
}
➔ Next to Policy Log Inspection Rule Details