FileSystemCollector¶

FileSystemCollector - Create¶

Creates a FileSystem Collector.

POST

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

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 Field
device_id	-	String	Existing Device id . Execute Devices - List API to list the available devices and use the value of the id parameter. Mandatory Field
excludes	Exclude Paths	[String]	Excluded path of the file. Optional Field
parser	Parser	String	Select a Parser for the collector. Execute Parsers - List API to list the available parsers and use the value of the name parameter. Mandatory Field
path	File Path	String	Starting Directory of the file. Mandatory Field
processpolicy	Processing Policy	String	Select a Processing Policy for the collector. Execute ProcessingPolicy - List API to list the available parsers and use the value of the id parameter. . Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "device_id": "57724aacd8aaa40b569bcb1f",
        "excludes": [
            "/var/log/h*.log"
        ],
        "parser": "LineParser",
        "path": "/var/log/upstart/*",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd"
    }
}

Success Response

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

FileSystemCollector - Edit¶

Edits a FileSystem Collector with given ID.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/FileSystemCollector/{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 Field
excludes	Exclude Paths	[String]	Excluded path and can be empty. Optional Field
id	-	String	Existing FileSystemCollector id . Mandatory Field
parser	Parser	String	Select a Parser for the collector. Execute Parsers - List API to list the available parsers and use the value of the name parameter. Mandatory Field
path	File Path	String	Starting Directory and cannot be empty. Mandatory Field
processpolicy	Processing Policy	String	Select a Processing Policy for the collector. Execute ProcessingPolicy - List API to list the available parsers and use the value of the id parameter. Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "excludes": [
            "/var/log/h*.log"
        ],
        "parser": "LineParser",
        "path": "/var/log/upstart/*",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd"
    }
}

Success Response

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

FileSystemCollector - Trash¶

Deletes a FileSystem Collector with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing FileSystemCollector id . Mandatory Field

Success Response

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

Helpful?