SystemSettingsEnrichment¶

SystemSettingsEnrichment - List¶

Lists the current Enrichment System Settings List.

GET

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

Success Response

[
    {
        "clients_map": {},
        "enrich_mode": null,
        "forwarders_map": {},
        "id": "5943684cd8aaa4770455df34",
        "is_forwarder": false,
        "is_standalone": true,
        "private_ip": "",
        "remote_ip": "192.168.1.4",
        "subscription_sources": [
            {
                "logpoint_identifier": "b82b60f63cb04e21b8782da16814ed07",
                "text": "LogPoint192 ( 10.45.1.192)",
                "value": "10.85.128.1"
            },
            {
                "logpoint_identifier": "ef803a513f5441d6b00b17810d39c140",
                "text": "LogPoint191 ( 10.45.1.191)",
                "value": "10.210.52.1"
            }
        ]
    }
]

SystemSettingsEnrichment - RefreshList¶

Syncs the current Enrichment System Settings List with LogPoint’s Enrichment System Settings List.

POST

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

Request Example

{
    "data": {}
}

Success Response

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

SystemSettingsEnrichment - Save¶

Updates the existing Enrichment System Settings.

POST

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

Parameter

Field	Label in UI	Type	Description
enrich_mode	Enrichment Propagation	String	Enrich mode value can be one of the following: source: Enrichment Provider. Collects and Shares the content of the Enrichment Source with Client LogPoints. client: Enrichment Subscriber. Receives the Enrichment Data from the Source machine. Mandatory only when the value of the standalone parameter is “off”. Optional Field
remote_ip	Subscription source	String	Remote source IP. Use the value of the required subscription source IP from SystemSettingsEnrichment - List API. Mandatory only when the value of the enrich_mode parameter is “client”. Optional Field
standalone	Standalone Mode	String	Values can be: on - Standalone Mode off - Distributed Mode. Mandatory Field

Request Example

{
    "data": {
        "enrich_mode": "source",
        "remote_ip": "192.168.4.32",
        "standalone": "on"
    }
}

Success Response

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

Helpful?