FTPCollectorPlugin¶

FTPCollectorPlugin - Create¶

Creates an FTP Collector.

POST

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

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset. Obtain the value of the required charset from Charsets - List API. Mandatory Field
device_id	-	String	Existing Device id . Obtain the value of the required device_id using Devices - List API. Optional Field
parser	Parser	String	Existing Parser name . Obtain the required parser name using Parsers - List API. Mandatory Field
password	Password	String	FTP Collector password . Mandatory 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 . Obtain the value of the required Processing Policy using ProcessingPolicy - List API. Mandatory Field
sourcename	Source Name	String	FTP Collector source name (Unique for that device). Mandatory Field
username	Username	String	FTP Collector username .(Unique for that device). Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "device_id": "57724aacd8aaa40b569bcb1f",
        "parser": "LineParser",
        "password": "password",
        "processpolicy": "59103b90854ff52c2506991f",
        "sourcename": "linuxBase",
        "username": "TestCollector"
    }
}

Success Response

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

FTPCollectorPlugin - Edit¶

Edits an FTP Collector with given ID.

PUT

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

Parameter

Field	Label in UI	Type	Description
charset	Charset	String	Existing LogPoint charset . Obtain the value of the required charset from Charsets - List API. Mandatory Field
id	-	String	FTPCollectorPlugin uuid . To obtain the FTP 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	Existing Parser name . Obtain the required parser name using Parsers - List API. Mandatory Field
password	Password	String	FTP Collector password . Mandatory Field
processpolicy	Processing Policy	String	Existing Processing Policy id . Obtain the value of the required Processing Policy id using ProcessingPolicy - List API. Mandatory Field
sourcename	Source Name	String	FTP Collector source name (Unique for that device). Mandatory Field
username	Username	String	FTP Collector username .(Unique for that device). Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "parser": "LineParser",
        "password": "password",
        "processpolicy": "59103b90854ff52c2506991f",
        "sourcename": "linuxBase",
        "username": "TestCollector"
    }
}

Success Response

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

FTPCollectorPlugin - Trash¶

Deletes an FTP Collector with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	FTPCollectorPlugin uuid . To obtain the FTP 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?