Syslog Configurations

Search Syslog Configurations

post/syslogconfigurations/search

Search for syslog configurations using optional filters.

Related SDK Methods:
Java

SyslogConfigurationsApi.searchSyslogConfigurations([param1, param2, ...])
Python

SyslogConfigurationsApi.search_syslog_configurations([param1, param2, ...])
JavaScript

SyslogConfigurationsApi.searchSyslogConfigurations([param1, param2, ...])

Security
Request
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 syslog configurations.

Request samples
application/json
{
  • "maxItems": 0,
  • "searchCriteria": [
    ],
  • "sortByObjectID": true
}
Response samples
application/json
{
  • "syslogConfigurations": [
    ]
}

List Syslog Configurations

get/syslogconfigurations

Lists all syslog configurations.

Related SDK Methods:
Java

SyslogConfigurationsApi.listSyslogConfigurations([param1, param2, ...])
Python

SyslogConfigurationsApi.list_syslog_configurations([param1, param2, ...])
JavaScript

SyslogConfigurationsApi.listSyslogConfigurations([param1, param2, ...])

Security
Request
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 syslog configurations.

Request samples
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SyslogConfigurationsApi;
import com.trendmicro.deepsecurity.model.SyslogConfigurations;


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

		
		// Initialization
		// Set Any Required Values
		SyslogConfigurationsApi instance = new SyslogConfigurationsApi();
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SyslogConfigurations result = instance.listSyslogConfigurations(apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SyslogConfigurationsApi.listSyslogConfigurations");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "syslogConfigurations": [
    ]
}

Create a Syslog Configuration

post/syslogconfigurations

Create a new syslog configuration.

Related SDK Methods:
Java

SyslogConfigurationsApi.createSyslogConfiguration([param1, param2, ...])
Python

SyslogConfigurationsApi.create_syslog_configuration([param1, param2, ...])
JavaScript

SyslogConfigurationsApi.createSyslogConfiguration([param1, param2, ...])

Security
Request
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 syslog configuration to modify.

agentDirectForwarding
boolean

Flag indicating whether access to the syslog configuration is directly to the syslog server (true) or is it via the manager (false). Default is "false".

certificateChain
Array of strings

Certificate chain of the syslog configuration. It's a PEM formatted string.

description
string

Description of the syslog configuration. The maximum length is 2000 characters. Searchable as String.

eventFormat
string

Event format of the syslog configuration. Default is "cef".

Enum: "standard" "cef" "leef"
facility
string

Facility of the syslog configuration. Default is "local0".

Enum: "kernel" "user" "mail" "daemon" "authorization" "syslog" "printer" "news" "uucp" "clock" "authpriv" "ftp" "ntp" "log-audit" "log-alert" "cron" "local0" "local1" "local2" "local3" "local4" "local5" "local6" "local7"
hostName
required
string

Server name of the syslog configuration. The maximum length is 253 characters. Searchable as String.

includeTimezone
boolean

Flag indicating whether time zone is included in events. Default is "false".

name
required
string

Name of the syslog configuration. The maximum length is 254 characters. Searchable as String.

port
integer <int32>

Port of the syslog configuration. Default is "514".

privateKey
string

Private key of the syslog configuration, write only. It's a PEM formatted string.

sourceIdentifier
string

Log source identifier of the syslog configuration. The maximum length is 254 characters.

transport
string

Transport of the syslog configuration. Default is "udp".

Enum: "udp" "tls"
Responses
200

successful operation

403

Not authorized to create syslog configurations.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "hostName": "string",
  • "port": 0,
  • "agentDirectForwarding": true,
  • "includeTimezone": true,
  • "privateKey": "string",
  • "certificateChain": [
    ],
  • "transport": "udp",
  • "eventFormat": "standard",
  • "facility": "kernel",
  • "sourceIdentifier": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "hostName": "string",
  • "port": 0,
  • "agentDirectForwarding": true,
  • "includeTimezone": true,
  • "privateKey": "string",
  • "certificateChain": [
    ],
  • "transport": "udp",
  • "eventFormat": "standard",
  • "facility": "kernel",
  • "sourceIdentifier": "string",
  • "lastStatus": 0,
  • "lastStatusDate": 0,
  • "ID": 0
}

Describe a Syslog Configuration

get/syslogconfigurations/{syslogConfigurationID}

Describe a syslog configuration by ID.

Related SDK Methods:
Java

SyslogConfigurationsApi.describeSyslogConfiguration([param1, param2, ...])
Python

SyslogConfigurationsApi.describe_syslog_configuration([param1, param2, ...])
JavaScript

SyslogConfigurationsApi.describeSyslogConfiguration([param1, param2, ...])

Security
Request
path Parameters
syslogConfigurationID
required
integer <int32> \d+

The ID number of the syslog configuration 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 syslog configurations.

404

The syslog configuration does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SyslogConfigurationsApi;
import com.trendmicro.deepsecurity.model.SyslogConfiguration;


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

		
		// Initialization
		// Set Any Required Values
		SyslogConfigurationsApi instance = new SyslogConfigurationsApi();
		Integer syslogConfigurationID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			SyslogConfiguration result = instance.describeSyslogConfiguration(syslogConfigurationID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SyslogConfigurationsApi.describeSyslogConfiguration");
			e.printStackTrace();
		}
	}
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "hostName": "string",
  • "port": 0,
  • "agentDirectForwarding": true,
  • "includeTimezone": true,
  • "privateKey": "string",
  • "certificateChain": [
    ],
  • "transport": "udp",
  • "eventFormat": "standard",
  • "facility": "kernel",
  • "sourceIdentifier": "string",
  • "lastStatus": 0,
  • "lastStatusDate": 0,
  • "ID": 0
}

Modify a Syslog Configuration

post/syslogconfigurations/{syslogConfigurationID}

Modify a syslog configuration by ID. Any unset elements will be left unchanged.

Related SDK Methods:
Java

SyslogConfigurationsApi.modifySyslogConfiguration([param1, param2, ...])
Python

SyslogConfigurationsApi.modify_syslog_configuration([param1, param2, ...])
JavaScript

SyslogConfigurationsApi.modifySyslogConfiguration([param1, param2, ...])

Security
Request
path Parameters
syslogConfigurationID
required
integer <int32> \d+

The ID number of the syslog configuration 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 syslog configuration to modify.

agentDirectForwarding
boolean

Flag indicating whether access to the syslog configuration is directly to the syslog server (true) or is it via the manager (false). Default is "false".

certificateChain
Array of strings

Certificate chain of the syslog configuration. It's a PEM formatted string.

description
string

Description of the syslog configuration. The maximum length is 2000 characters. Searchable as String.

eventFormat
string

Event format of the syslog configuration. Default is "cef".

Enum: "standard" "cef" "leef"
facility
string

Facility of the syslog configuration. Default is "local0".

Enum: "kernel" "user" "mail" "daemon" "authorization" "syslog" "printer" "news" "uucp" "clock" "authpriv" "ftp" "ntp" "log-audit" "log-alert" "cron" "local0" "local1" "local2" "local3" "local4" "local5" "local6" "local7"
hostName
required
string

Server name of the syslog configuration. The maximum length is 253 characters. Searchable as String.

includeTimezone
boolean

Flag indicating whether time zone is included in events. Default is "false".

name
required
string

Name of the syslog configuration. The maximum length is 254 characters. Searchable as String.

port
integer <int32>

Port of the syslog configuration. Default is "514".

privateKey
string

Private key of the syslog configuration, write only. It's a PEM formatted string.

sourceIdentifier
string

Log source identifier of the syslog configuration. The maximum length is 254 characters.

transport
string

Transport of the syslog configuration. Default is "udp".

Enum: "udp" "tls"
Responses
200

successful operation

403

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

404

The syslog configuration does not exist.

Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "hostName": "string",
  • "port": 0,
  • "agentDirectForwarding": true,
  • "includeTimezone": true,
  • "privateKey": "string",
  • "certificateChain": [
    ],
  • "transport": "udp",
  • "eventFormat": "standard",
  • "facility": "kernel",
  • "sourceIdentifier": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "hostName": "string",
  • "port": 0,
  • "agentDirectForwarding": true,
  • "includeTimezone": true,
  • "privateKey": "string",
  • "certificateChain": [
    ],
  • "transport": "udp",
  • "eventFormat": "standard",
  • "facility": "kernel",
  • "sourceIdentifier": "string",
  • "lastStatus": 0,
  • "lastStatusDate": 0,
  • "ID": 0
}

Delete a Syslog Configuration

delete/syslogconfigurations/{syslogConfigurationID}

Delete a syslog configuration by ID.

Related SDK Methods:
Java

SyslogConfigurationsApi.deleteSyslogConfiguration([param1, param2, ...])
Python

SyslogConfigurationsApi.delete_syslog_configuration([param1, param2, ...])
JavaScript

SyslogConfigurationsApi.deleteSyslogConfiguration([param1, param2, ...])

Security
Request
path Parameters
syslogConfigurationID
required
integer <int32> \d+

The ID number of the syslog configuration 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.

403

Not authorized to delete syslog configurations.

Request samples
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.SyslogConfigurationsApi;


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

		
		// Initialization
		// Set Any Required Values
		SyslogConfigurationsApi instance = new SyslogConfigurationsApi();
		Integer syslogConfigurationID = 1;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			instance.deleteSyslogConfiguration(syslogConfigurationID, apiVersion);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling SyslogConfigurationsApi.deleteSyslogConfiguration");
			e.printStackTrace();
		}
	}
}
➔ Next to Agent Activation Information