Fetches a Plugin with given ID.
GET
https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Plugins/{id}
Parameter
Field |
Label in UI |
Type |
Description |
|---|---|---|---|
id |
- |
String |
Existing Plugin id . |
Success Response
{
"authentication": {
"LDAPAuthentication": {
"description": "Configure LDAP Strategies needed for LDAP Authentication",
"manage": "App.pluggables.modules.Authentication.apps.LDAPAuthentication.Manage",
"name": "LDAPAuthentication",
"preinstalled": true,
"symlinks": "{}",
"type": "authentication",
"ui_text": "LDAP Authentication",
"version": "1.0"
}
},
"description": "This package contains all the default KB components and LogPoint plugins.",
"errors": [],
"fetchers": {
"SnmpFetcher": {
"description": "Configure Snmp Policies needed for adding Snmp Fetcher",
"manage": "App.pluggables.modules.Collection.apps.SNMPFetcher.Manage",
"name": "SnmpFetcher",
"no_config_generation": true,
"preinstalled": true,
"symlinks": "{}",
"type": "fetchers",
"ui_text": "Snmp Fetcher",
"version": "1.0"
}
},
"id": "592fe14ad8aaa408672de0e5",
"knowledgebase": {
"LogPoint": {
"name": "LogPoint",
"type": "knowledgebase",
"version": "3.1.0"
}
},
"name": "LogPoint",
"not_deleteable": false,
"older_versions": [],
"plugins": {
"MemoryNotification": {
"enabled": true,
"extra_info": {
"interval": 60,
"notification_type": "Memory Usage",
"scheduling": true
},
"latest_version": "1.0",
"type": "system_notification",
"version": "1.0"
}
},
"system_notification": {
"CPUNotification": {
"description": "Configure High CPU usage notifications",
"extra_info": {
"interval": 60,
"notification_type": "CPU Usage",
"scheduling": true
},
"manage": "App.pluggables.modules.SystemNotification.apps.CPUNotification.Manage",
"name": "CPUNotification",
"preinstalled": true,
"symlinks": "{}",
"type": "system_notification",
"ui_text": "CPU Notification",
"version": "1.0"
},
"DiskNotification": {
"description": "Configure High Disk usage notifications",
"extra_info": {
"interval": 3600,
"notification_type": "Disk Usage",
"scheduling": true
},
"manage": "App.pluggables.modules.SystemNotification.apps.DiskNotification.Manage",
"name": "DiskNotification",
"preinstalled": true,
"symlinks": "{}",
"type": "system_notification",
"ui_text": "Disk Notification",
"version": "1.0"
},
"MemoryNotification": {
"description": "Configure High Memory usage notifications",
"extra_info": {
"interval": 60,
"notification_type": "Memory Usage",
"scheduling": true
},
"manage": "App.pluggables.modules.SystemNotification.apps.MemoryNotification.Manage",
"name": "MemoryNotification",
"preinstalled": true,
"symlinks": "{}",
"type": "system_notification",
"ui_text": "Memory Notification",
"version": "1.0"
}
},
"tid": "",
"version": "3.1.0"
}
Lists all the Plugins.
GET
https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Plugins
Success Response
[
{
"description": "This package contains pluggable CSVEnrichmentSource.",
"enrichmentsource": {
"CSVEnrichmentSource": {
"config_gen_script": "CSVEnrichmentSourceCfgGen.py",
"extra_fields_in_sid": [],
"manage": "",
"name": "CSVEnrichmentSource",
"no_config_generation": false,
"no_config_generation_lite": true,
"post_install": "post_install.sh",
"pre_install": "",
"service_name": "csvenrichmentsource",
"service_run_script": "csvenrichmentsource/CSVEnrichmentSource.py",
"symlinks": "{\"/opt/immune/app_store/col/pluggable/CSVEnrichmentSource/webserver/CSV\"}",
"type": "enrichmentsource",
"ui": "ui/CSV",
"ui_text": "CSVEnrichmentSource",
"uninstall_script": "uninstall.sh",
"version": "3.0.0.10",
"webserver": "webserver/CSV"
}
},
"errors": [],
"id": "592fe11dd8aaa47ce69717a8",
"name": "CSVEnrichmentSource",
"not_deleteable": false,
"older_versions": [],
"plugins": {
"CSVEnrichmentSource": {
"enabled": true,
"extra_info": {},
"latest_version": "3.0.0.10",
"type": "enrichmentsource",
"version": "3.0.0.10"
}
},
"tid": "",
"version": "3.0.0.10"
}
]
Lists all Plugins versions.
GET
https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Plugins/PluginInfo
Success Response
[
{
"id": "5b4835e73c4eaa7fb08064fd",
"name": "DirectorPOCFetcher",
"type": "fetchers",
"version": "3.0.1"
}
]
Uninstalls the Plugin with given ID.
DELETE
https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Plugins/{id}
Parameter
Field |
Label in UI |
Type |
Description |
|---|---|---|---|
id |
- |
String |
Existing Plugin id . Mandatory Field |
Success Response
{
"status": "Success",
"message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}
We are glad this guide helped.
Please don't include any personal information in your comment
Contact Support