Search Syslog Configurations
Search for syslog configurations using optional filters.
SyslogConfigurationsApi.searchSyslogConfigurations([param1, param2, ...])
SyslogConfigurationsApi.search_syslog_configurations([param1, param2, ...])
SyslogConfigurationsApi.searchSyslogConfigurations([param1, param2, ...])
header Parameters
Request Body schema: application/json
A collection of options used to filter the search results.
successful operation
Not authorized to view syslog configurations.
- Payload
- Java
- Python
- JavaScript
{- "maxItems": 0,
- "searchCriteria": [
- {
- "fieldName": "string",
- "booleanTest": true,
- "numericTest": "less-than",
- "numericValue": 0,
- "numericValueList": [
- 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",
- "idValueList": [
- 0
]
}
], - "sortByObjectID": true
}
- 200
{- "syslogConfigurations": [
- {
- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string",
- "lastStatus": 0,
- "lastStatusDate": 0,
- "ID": 0
}
]
}
List Syslog Configurations
Lists all syslog configurations.
SyslogConfigurationsApi.listSyslogConfigurations([param1, param2, ...])
SyslogConfigurationsApi.list_syslog_configurations([param1, param2, ...])
SyslogConfigurationsApi.listSyslogConfigurations([param1, param2, ...])
successful operation
Not authorized to view syslog configurations.
- Java
- Python
- JavaScript
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(); } } }
- 200
{- "syslogConfigurations": [
- {
- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string",
- "lastStatus": 0,
- "lastStatusDate": 0,
- "ID": 0
}
]
}
Create a Syslog Configuration
Create a new syslog configuration.
SyslogConfigurationsApi.createSyslogConfiguration([param1, param2, ...])
SyslogConfigurationsApi.create_syslog_configuration([param1, param2, ...])
SyslogConfigurationsApi.createSyslogConfiguration([param1, param2, ...])
header Parameters
Request Body schema: application/json
The settings of the syslog configuration to modify.
successful operation
Not authorized to create syslog configurations.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string"
}
- 200
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string",
- "lastStatus": 0,
- "lastStatusDate": 0,
- "ID": 0
}
Describe a Syslog Configuration
Describe a syslog configuration by ID.
SyslogConfigurationsApi.describeSyslogConfiguration([param1, param2, ...])
SyslogConfigurationsApi.describe_syslog_configuration([param1, param2, ...])
SyslogConfigurationsApi.describeSyslogConfiguration([param1, param2, ...])
successful operation
Not authorized to view syslog configurations.
The syslog configuration does not exist.
- Java
- Python
- JavaScript
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(); } } }
- 200
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string",
- "lastStatus": 0,
- "lastStatusDate": 0,
- "ID": 0
}
Modify a Syslog Configuration
Modify a syslog configuration by ID. Any unset elements will be left unchanged.
SyslogConfigurationsApi.modifySyslogConfiguration([param1, param2, ...])
SyslogConfigurationsApi.modify_syslog_configuration([param1, param2, ...])
SyslogConfigurationsApi.modifySyslogConfiguration([param1, param2, ...])
path Parameters
header Parameters
Request Body schema: application/json
The settings of the syslog configuration to modify.
successful operation
Not authorized to modify syslog configurations or the requested modification is not permitted.
The syslog configuration does not exist.
- Payload
- Java
- Python
- JavaScript
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string"
}
- 200
{- "name": "string",
- "description": "string",
- "hostName": "string",
- "port": 0,
- "agentDirectForwarding": true,
- "includeTimezone": true,
- "privateKey": "string",
- "certificateChain": [
- "string"
], - "transport": "udp",
- "eventFormat": "standard",
- "facility": "kernel",
- "sourceIdentifier": "string",
- "lastStatus": 0,
- "lastStatusDate": 0,
- "ID": 0
}
Delete a Syslog Configuration
Delete a syslog configuration by ID.
SyslogConfigurationsApi.deleteSyslogConfiguration([param1, param2, ...])
SyslogConfigurationsApi.delete_syslog_configuration([param1, param2, ...])
SyslogConfigurationsApi.deleteSyslogConfiguration([param1, param2, ...])
Request is successful.
Not authorized to delete syslog configurations.
- Java
- Python
- JavaScript
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(); } } }