SnareCollectorPlugin¶

SnareCollectorPlugin - Create¶

Creates a Snare Collector Plugin using device ID or policy ID.

POST

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

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	Device id . Use the value of the id parameter of the required Devices from the Devices - List API. Optional Field
parser	Parser	String	Existing Parser name or None (exact). Use the value of the name parameter from Parsers - List API. 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 or None (exact). Use the value of the id parameter of the required Processing Policy from ProcessingPolicy - List API. Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "device_id": "57724aacd8aaa40b569bcb1f",
        "parser": "LineParser",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd"
    }
}

Success Response

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

SnareCollectorPlugin - Edit¶

Edits the Snare Collector Plugin with given ID.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SnareCollectorPlugin/{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
id	-	String	Existing Snare Collector Plugin uuid . To obtain the Snare 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 or None (exact). Use the value of the name parameter from Parsers - List API. Mandatory Field
processpolicy	Processing Policy	String	Existing Processing Policy id or None (exact). Use the value of the id parameter of the required Processing Policy from ProcessingPolicy - List API. Mandatory Field

Request Example

{
    "data": {
        "charset": "utf_8",
        "parser": "LineParser",
        "processpolicy": "57724aacd8aaa40b569bcb1fasd"
    }
}

Success Response

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

SnareCollectorPlugin - Trash¶

Deletes the Snare Collector Plugin with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing Snare Collector Plugin uuid . To obtain the Snare 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?