LogCollectionPolicies¶

LogCollectionPolicies - Create¶

Add a new log collection policy

POST

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

Parameter

Field	Label in UI	Type	Description
description	Description	String	Description for the log collection policy. Optional Field
name	Name	String	Name of the log collection policy. Valid unique string. Mandatory Field

Request Example

{
    "data": {
        "description": "Created from API",
        "name": "lcp1"
    }
}

Success Response

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

LogCollectionPolicies - Edit¶

Edit a log collection policy with given ID

PUT

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

Parameter

Field	Label in UI	Type	Description
description	Description	String	Description for the log collection policy. Optional Field
id	-	String	Existing log collection policy id . Obtain the value of the required log collection policy id using LogCollectionPolicies-List API. Mandatory Field

Request Example

{
    "data": {
        "description": "Created from API"
    }
}

Success Response

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

LogCollectionPolicies - Get¶

Get log collection policy by given ID

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing log collection policy that you want to fetch.

Success Response

{
    "active": true,
    "col_apps": [
        {
            "app": "FTPFetcher",
            "charset": "utf_8",
            "interval": "5",
            "namepattern": "*.pyc",
            "oldlogs": "on",
            "parser": "LineParser",
            "password": "8PEzHGOmgWSf/rs8ETgyC5xbuzYwhGc/AWZ477uUhZU=",
            "policy_id": "5bbf4095d8aaa4276a2c1255",
            "port": "5800",
            "processpolicy": "5ab9f74cd8aaa45ad3e31e42",
            "remotepath": "/base/collection/",
            "sid": "ftpf|lcp21:testcollector:5800:/base/collection/:*.pyc",
            "username": "TestCollector",
            "uuid": "73e30fc730cd4dc98b3f7e635b35eabf"
        }
    ],
    "description": "CreatedFromAPI",
    "id": "5bbf4095d8aaa4276a2c1255",
    "name": "lcp21",
    "tid": ""
}

LogCollectionPolicies - GetPlugins¶

Get plugins by given log collection policy ID

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing log collection policy that you want to fetch.

Success Response

[
    {
        "CSRFToken": "cknHNJFOKZGrCfm",
        "LOGGEDINUSER": "admin",
        "app": "SnareCollector",
        "charset": "utf_8",
        "hasLCP": "0",
        "ips": "181.170.0.101",
        "normalizer": "None",
        "parser": "LineParser",
        "repo": "default",
        "requestType": "formsubmit",
        "sid": "snare|device-NewDevice_101"
    },
    {
        "CSRFToken": "cknHNJFOKZGrCfm",
        "LOGGEDINUSER": "admin",
        "app": "SyslogCollector",
        "charset": "utf_8",
        "hasLCP": "0",
        "ips": "181.170.0.101",
        "normalizer": "None",
        "parser": "SyslogParser",
        "proxy_condition": "None",
        "repo": "default",
        "requestType": "formsubmit",
        "sid": "syslog|device-NewDevice_101"
    }
]

LogCollectionPolicies - List¶

Lists all log collection policies in the Fabric-enabled LogPoint.

GET

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

Success Response

[
    {
        "active": true,
        "col_apps": [
            {
                "app": "FTPFetcher",
                "charset": "utf_8",
                "interval": "5",
                "namepattern": "*.pyc",
                "oldlogs": "on",
                "parser": "LineParser",
                "password": "8PEzHGOmgWSf/rs8ETgyC5xbuzYwhGc/AWZ477uUhZU=",
                "policy_id": "5bbf4095d8aaa4276a2c1255",
                "port": "5800",
                "processpolicy": "5ab9f74cd8aaa45ad3e31e42",
                "remotepath": "/base/collection/",
                "sid": "ftpf|lcp21:testcollector:5800:/base/collection/:*.pyc",
                "username": "TestCollector",
                "uuid": "73e30fc730cd4dc98b3f7e635b35eabf"
            }
        ],
        "description": "CreatedFromAPI",
        "id": "5bbf4095d8aaa4276a2c1255",
        "name": "lcp21",
        "tid": ""
    },
    {
        "active": true,
        "col_apps": [],
        "description": "",
        "id": "5bc09048d8aaa4285487f21d",
        "name": "lcp_test",
        "tid": ""
    }
]

LogCollectionPolicies - Trash¶

Delete a log collection policy of given ID

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing log collection policy that you want to delete. Mandatory Field

Success Response

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

Helpful?