SyslogCollector¶

SyslogCollector - Create¶

Creates a Syslog Collector.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SyslogCollector

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset. Obtain the value of the required charset using Charsets - List API. Mandatory only when proxy_condition is use_as_proxy or None. Optional Field
device_id	-	String	Existing Device id . Obtain the value of the required device_id using Devices - List API. Optional Field
hostname	HostName	[String]	List of server hostname of the Server(s) where the value of the proxy_condition parameter is “uses_proxy”. Optional Field
parser	Parser	String	Value must be one of the following: SyslogParser LineParser MultiLineSyslogParser ProofPointEmailProtectionLogParser EmailParser Mandatory only when the value of the proxy_condition parameter is “use_as_proxy” or “None”. Optional Field
policy_id	-	String	Respective LCP policy ID. Obtain the value of the required policy_id using LogCollectionPolicies - List API. Optional Field
processpolicy	Processing Policy	String	Existing Processing Policy id or “None”. Execute the ProcessingPolicy - List API to obtain the value of the required Processing Policy id . Mandatory only when the value of ‘proxy_condition’ is “uses_proxy” or “None”. Optional Field
proxy_condition	Proxy Server	String	Value can be “uses_proxy”, “use_as_proxy” or “None”. Mandatory Field
proxy_ip	Proxy IP	[String]	List of IP address of the Proxy Server(s) where the value of the proxy_condition parameter is “uses_proxy”. Optional Field

Request Example

{
    "data": {
        "device_id": "57724aacd8aaa40b569bcb1f",
        "hostname": [
            "Logpoint"
        ],
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "proxy_condition": "uses_proxy",
        "proxy_ip": [
            "1.1.1.1"
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

SyslogCollector - Edit¶

Edits the Syslog Collector with given ID.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SyslogCollector/{id}

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset. Obtain the value of the required charset using Charsets - List API. Mandatory only when proxy_condition is use_as_proxy or None. Optional Field
hostname	HostName	[String]	List of server hostname of the Server(s) where the value of the proxy_condition parameter is “uses_proxy”. Optional Field
id	-	String	UUID of the respective SyslogCollector. To obtain the Syslog collector uuid , execute Devices - List API if the collector was configured using device id or execute LogCollectionPolicies - List API if the collector was configured using log collection policy id . Mandatory Field
parser	Parser	String	Value must be one of the following: SyslogParser LineParser MultiLineSyslogParser ProofPointEmailProtectionLogParser EmailParser Mandatory only when the value of the proxy_condition parameter is “use_as_proxy” or “None”. Optional Field
processpolicy	Processing Policy	String	Existing Processing Policy id or “None”. Execute the ProcessingPolicy - List API to obtain the value of the required Processing Policy id . Mandatory only when the value of ‘proxy_condition’ is “uses_proxy” or “None”. Optional Field
proxy_condition	Proxy Server	String	Value can be “uses_proxy”, “use_as_proxy” or “None”. Mandatory Field
proxy_ip	Proxy IP	[String]	List of IP address of the Proxy Server(s) where the value of the proxy_condition parameter is “uses_proxy”. Optional Field

Request Example

{
    "data": {
        "hostname": [
            "Logpoint"
        ],
        "processpolicy": "57724aacd8aaa40b569bcb1fasd",
        "proxy_condition": "uses_proxy",
        "proxy_ip": [
            "1.1.1.1"
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

SyslogCollector - Trash¶

Deletes the Syslog Collector with given ID.

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SyslogCollector/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	UUID of the respective SyslogCollector. To obtain the Syslog collector uuid , execute Devices - List API if the collector was configured using device id or execute LogCollectionPolicies - List API if the collector was configured using log collection policy id . Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?