Page Contents

PluginConfiguration

PluginConfiguration¶

PluginConfiguration - Create¶

To configure plugin

POST

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

Parameter

Field	Label in UI	Type	Description
data		Object	Plugin configuration in json format. Mandatory Field

Request Example

{
    "data": {
        "frequency": 5,
        "query": "device_name=localhost",
        "repo": "_logpoint"
    }
}

Success Response

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

PluginConfiguration - Edit¶

To update plugin configuration

PUT

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

Parameter

Field	Label in UI	Type	Description
data		Object	Plugin configuration in json format. Mandatory Field
id		String	Existing plugin configuration id. Mandatory Field

Request Example

{
    "data": {
        "frequency": 5,
        "query": "device_name=localhost",
        "repo": "_logpoint"
    }
}

Success Response

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

PluginConfiguration - EditInstall¶

Edit the install of the given file inside a plugin.

DEPRECATED ! Use PluginConfiguration Edit API instead. Will be removed in future version.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PluginConfiguration/{plugin_name}/install/{id}

Parameter

Field	Label in UI	Type	Description
file_location		String	Location of the file to install. can be either ‘private’ or ‘public’. Mandatory Field
id		String	Unique id. Mandatory Field

Request Example

{
    "data": {
        "file_location": "private",
        "files": {
            "file_key_1": "file_name_1.txt",
            "file_key_2": "file_name_2.crt"
        },
        "key2": "value2"
    }
}

Success Response

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

PluginConfiguration - Get¶

Get a plugin configurations by id

GET

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

Parameter

Field	Label in UI	Type	Description
id		String	Existing plugin configuration id

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"
    }
]

PluginConfiguration - Install¶

Installs the given file inside a plugin.

DEPRECATED ! Use PluginConfiguration Create API instead. Will be removed in future version.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PluginConfiguration/{plugin_name}/install

Parameter

Field	Label in UI	Type	Description
file_location		String	Location of the file to install. can be either ‘private’ or ‘public’. Mandatory Field

Request Example

{
    "data": {
        "file_location": "private",
        "files": {
            "file_key_1": "file_name_1.txt",
            "file_key_2": "file_name_2.crt"
        },
        "key2": "value2"
    }
}

Success Response

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

PluginConfiguration - List¶

Get a plugin configurations

GET

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

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"
    }
]

PluginConfiguration - ListPlugins¶

List all the pluggable plugins installed in the given logpoint

GET

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

Success Response

[
    {
        "id": "5bdaca3f20c20868893e8321",
        "name": "DirectorPOCFetcher",
        "type": "fetchers",
        "version": "3.0.1"
    }
]

PluginConfiguration - ListPrivateUploads¶

List all files in private storage for a plugin

GET

https://api-server-host-name/configapi/{pool_UUID}/PluginConfiguration/{plugin_name}/list

Success Response

[
    "test.pak"
]

PluginConfiguration - ListPublicUploads¶

List all files in public storage for a plugin

GET

https://api-server-host-name/configapi/PluginConfiguration/{plugin_name}/list

Success Response

[
    "test.pak"
]

PluginConfiguration - RefreshList¶

To sync plugin configuration collections

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PluginConfiguration/{plugin_name}/refreshlist

Parameter

Field	Label in UI	Type	Description
data		Object	Plugin configuration in json format. Mandatory Field

Request Example

{
    "data": {}
}

Success Response

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

PluginConfiguration - TestExisting¶

To test existing plugin configuration

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PluginConfiguration/{plugin_name}/{id}/testexisting

Parameter

Field	Label in UI	Type	Description
id		String	UUID of the respective Plugin. Mandatory Field

Request Example

{
    "data": {}
}

Success Response

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

PluginConfiguration - TestNew¶

To test plugin configuration

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PluginConfiguration/{plugin_name}/testnew

Parameter

Field	Label in UI	Type	Description
data		Object	Plugin configuration in json format. Mandatory Field

Request Example

{
    "data": {
        "frequency": 5,
        "query": "device_name=localhost",
        "repo": "_logpoint"
    }
}

Success Response

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

PluginConfiguration - Trash¶

Delete the plugin configuration with given ID

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/PluginConfiguration/{plugin_name}/{id}?action={action}

Parameter

Field	Label in UI	Type	Description
action		String	Query string indicating special action for a plugin. Optional Field
id		String	Existing plugin configuration id. Mandatory Field

Success Response

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

PluginConfiguration - TrashPrivateUploads¶

Delete the file with given name from private storage for a plugin

DELETE

https://api-server-host-name/configapi/{pool_UUID}/PluginConfiguration/{plugin_name}/{file_name}

Parameter

Field	Label in UI	Type	Description
file_name		String	File to be deleted. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "test1.pak successfully deleted from plugin's private storage."
}

PluginConfiguration - TrashPublicUploads¶

Delete the file with given name from public storage for a plugin

DELETE

https://api-server-host-name/configapi/PluginConfiguration/{plugin_name}/{file_name}

Parameter

Field	Label in UI	Type	Description
file_name		String	File to be deleted. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "test1.pak successfully deleted"
}

PluginConfiguration - Upload¶

Upload plugin specific files to private storage. Validation of maximum number of files and maximum size of each file done.

POST

https://api-server-host-name/configapi/{pool_UUID}/PluginConfiguration/{plugin_name}/upload

Header

Field	Label in UI	Description
Content-Type		multipart/form-data
replace_existing		Set the value of this parameter as ‘true’ to replace the existing file with the same name with the new file. Default value is ‘false’. Value can be ‘true’ or ‘false’. Optional field

Parameter

Field	Label in UI	Type	Description
file_name		[Object]	File to be uploaded. There can be multiple instances of this parameter as per the plugin need. If same key is used multiple times in the same request, only a single key/value pair will be used. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "test.pak successfully uploaded in private storage. "
}

PluginConfiguration - UploadPublic¶

Upload plugin specific files to public storage. Validation of maximum number of files and maximum size of each file done.

POST

https://api-server-host-name/configapi/PluginConfiguration/{plugin_name}/publicupload

Header

Field	Label in UI	Description
Content-Type		multipart/form-data
replace_existing		Set the value of this parameter as ‘true’ to replace the existing file with the same name with the new file. Default value is ‘false’. Value can be ‘true’ or ‘false’. Optional field

Parameter

Field	Label in UI	Type	Description
file_name		[Object]	File to be uploaded. There can be multiple instances of this parameter as per the plugin need. If same key is used multiple times in the same request, only a single key/value pair will be used. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "test.pak successfully uploaded in public storage. "
}

Helpful?