SystemSettingsGeneral¶

SystemSettingsGeneral - List¶

Lists all General System Settings.

GET

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

Success Response

[
    {
        "auth_ldap": false,
        "auth_li": true,
        "buffering": false,
        "default_auth": "LogpointAuthentication",
        "default_ha_path": "/opt/immune/storage",
        "enable_soar": true,
        "id": "591ec024d8aaa45be61fab2c",
        "identifier": "3f6d4866f6f6437eaf0737869ad948a2",
        "ip_dns": "10.232.21.1",
        "is_msui": false,
        "lp_mode": "search_head",
        "name": "LogpointMain",
        "overscan_period": 1.0,
        "sequence_number": false,
        "share_usage_data": false,
        "tab_title": "Logpoint",
        "timeout": 30,
        "timestamp_on": "col_ts",
        "timezone": "Asia/Kathmandu",
        "type": "installation"
    }
]

SystemSettingsGeneral - ListAuth¶

Lists all available authentication types for Logpoint.

GET

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

Success Response

[
    {
        "name": "LogpointAuthentication",
        "text": "Logpoint Authentication"
    },
    {
        "name": "LDAPAuthentication",
        "text": "LDAP Authentication"
    }
]

SystemSettingsGeneral - RefreshAuthList¶

Syncs the list of the available authentication types for Logpoint.

POST

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

Request Example

{
    "data": {}
}

Success Response

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

SystemSettingsGeneral - Save¶

Updates the existing General System Settings.

POST

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

Parameter

Field	Label in UI	Type	Description
default_auth	Default Login Screen From	String	Default Logpoint authentiation type. Obtain the value of the required authentication type name using SystemSettingsGeneral - ListAuth API. Mandatory Field.
default_ha_path	Path	String	Default High-Availability repo path. Mandatory Field.
enable_soar	SOAR	boolean	Enable or disable SOAR. Value can be “true” or “false”. Value will be retained in absence of the enable_soar parameter in the request. Optional Field.
li_ip	Server Alias	String	Logpoint IP address. Mandatory Field.
lp_mode	Modes	String	Mode of logpoint. Possible values are “search_head” and “dlp”. Mandatory Field.
name	Logpoint Name	String	Logpoint name. Mandatory Field.
overscan_period	Over Scan Period (in minutes)	int	Overscan period. Mandatory Field.
share_usage_data	Share Usage Data	boolean	Shares user’s usage data with Logpoint. Value can be “true” or “false”. The default value is “false”. Set the value to “true” to share the usage data. Optional Field.
tab_title	Browser tab title	String	Tab title for the Logpoint. Optional Field.
timeout	Timeout (minutes)	int	Idle timeout for the session. Mandatory Field.
timestamp_on	Apply Time Range On	String	Timestamp to index the logs. Possible values are ‘log_ts’ and ‘col_ts’. Mandatory Field.
timezone	Time Zone	String	One of the timezones given by Logpoint. Obtain the available timezones using Timezone - List API. Mandatory Field.

Request Example

{
    "data": {
        "default_auth": "LogpointAuthentication",
        "default_ha_path": "/opt/immune/storage",
        "enable_soar": "true",
        "li_ip": "192.168.0.0",
        "lp_mode": "search_head",
        "name": "LogpointTest",
        "overscan_period": 1,
        "share_usage_data": "true",
        "tab_title": "MyLogpoint",
        "timeout": 30,
        "timestamp_on": "col_ts",
        "timezone": "Asia/Kathmandu"
    }
}

Success Response

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

Helpful?