Page Contents

LogSources

LogSources¶

LogSources - Create¶

Creates a new log source.

POST

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

Parameters

Field	Label in UI	Type	Description
config	-	json	Configuration of log source. Go to Universal REST API for Director Console API for more information on the configuration parameters to create log source using Universal Rest API Fetcher. Mandatory Field.
dc_metadata	-	json	Information related to log source template created in the Director Console. Optional Field.
description	Description	String	Additional information or details about the log source. Optional Field.
documentation_link	Documentation Link	String	URL or hyperlink that points to external documentation or reference materials associated with that specific log source. Optional Field.
logo	Logo	String	Base64 encoded logo image. Optional Field.
name	Name	String	Name of the log source. Mandatory Field.
type	-	String	Type or category of the log-generating device, application, or system from which the log data originates. Mandatory Field.
vendor_name	Vendor Name	String	Name of vendor where the log data originates. Optional Field.

Request Example

{
    "data":{
        "name": "logsource_name",
        "type": "UniversalRestApi",
        "vendor_name": "",
        "logo": "",
        "description": "",
        "documentation_link": "",
        "config": {
            "Source": {
                "name": "source_name",
                "base_url": "https://10.45.9.123",
                "request_timeout": 30,
                "retry_after": 10,
                "interval": 30,
                "charset": "utf_8"
            },
            "Connector": {
                "auth_type": "none",
                "custom_headers": [
                {
                    "key": "id",
                    "value": "15"
                }
                ],
                "enforce_https": true,
                "enable_proxy": false,
                "protocol": "http"
            },
            "Endpoints": [
                {
                "endpoint_name": "getApps",
                "method": "get",
                "endpoint": "/apps",
                "endpoints_custom_headers": [],
                "query_params": [],
                "incremental_value_response_field": "event",
                "log_filter_params_dataformat": "iso",
                "log_filter_params_from_value": "2023-10-05 11:13:47",
                "id": "bbf30918-8605-4f1f-8d7c-93ce3489d57e"
                }
            ],
            "RoutingPolicy": {
                "routing_criterion": [],
                "catch_all": "_logpoint"
            },
            "NormalizationPolicy": {
                "normalizers": [
                {
                    "name": "ThycoticSecretServerCompiledNormalizer",
                    "type": "compiled"
                },
                {
                    "name": "JSONCompiledNormalizer",
                    "type": "compiled"
                }
                ]
            },
            "EnrichmentPolicy": "642beb329fab980b50e4bb7e"
        }
    }
}

Success Response

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

LogSources - Edit¶

Edits the log source with given ID.

PUT

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

Parameter

Field	Label in UI	Type	Description
config	-	json	Configuration of log source. Mandatory Field.
dc_metadata	-	json	Information related to log source template created in the Director Console. Optional Field.
description	Description	String	Additional information or details about the log source. Optional Field.
documentation_link	Documentation Link	String	URL or hyperlink that points to external documentation or reference materials associated with that specific log source. Optional Field.
id	-	String	Existing log source ID. Mandatory Field.
logo	Logo	String	Base64 encoded logo image. Optional Field.
name	Name	String	Name of log source. Mandatory Field.
type	-	String	Type or category of the log-generating device, application, or system from which the log data originates. Mandatory Field.
vendor_name	Vendor Name	String	Name of vendor where the log data originates. Optional Field.

Request Example

{
    "data":{
        "name": "logsource_name",
        "type": "UniversalRestApi",
        "vendor_name": "",
        "logo": "",
        "description": "",
        "documentation_link": "",
        "config": {
            "Source": {
                "name": "source_name",
                "base_url": "https://10.45.9.123",
                "request_timeout": 30,
                "retry_after": 10,
                "interval": 30,
                "charset": "utf_8"
            },
            "Connector": {
                "auth_type": "none",
                "custom_headers": [
                {
                    "key": "id",
                    "value": "15"
                }
                ],
                "enforce_https": true,
                "enable_proxy": false,
                "protocol": "http"
            },
            "Endpoints": [
                {
                "endpoint_name": "getApps",
                "method": "get",
                "endpoint": "/apps",
                "endpoints_custom_headers": [],
                "query_params": [],
                "incremental_value_response_field": "event",
                "log_filter_params_dataformat": "iso",
                "log_filter_params_from_value": "2023-10-05 11:13:47",
                "id": "bbf30918-8605-4f1f-8d7c-93ce3489d57e"
                }
            ],
            "RoutingPolicy": {
                "routing_criterion": [],
                "catch_all": "_logpoint"
            },
            "NormalizationPolicy": {
                "normalizers": [
                {
                    "name": "ThycoticSecretServerCompiledNormalizer",
                    "type": "compiled"
                },
                {
                    "name": "JSONCompiledNormalizer",
                    "type": "compiled"
                }
                ]
            },
            "EnrichmentPolicy": "642beb329fab980b50e4bb7e"
        }
    }
}

Success Response

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

LogSources - Get¶

Fetches a log source with given ID.

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing log source to fetch.

Success Response

{
    "name": "LogSource",
    "log_source_type": "UniversalRestApi",
    "vendor_name": "",
    "logo": "",
    "description": "",
    "documentation_link": "",
    "config": {
        "Source": {
            "name": "LogSource",
            "base_url": "https://10.45.9.123",
            "request_timeout": 30,
            "retry_after": 10,
            "interval": 30,
            "charset": "utf_8",
            "source_name": "06f148533e9ac62e268e91dd790a8cfb",
            "sid": "06f148533e9ac62e268e91dd790a8cfb|10.45.9.123",
            "identifier": null
        },
        "Connector": {
            "auth_type": "none",
            "custom_headers": [
                {
                    "key": "id",
                    "value": "15"
                }
            ],
            "enforce_https": true,
            "enable_proxy": false,
            "protocol": "http",
            "ip": "",
            "port": ""
        },
        "Endpoints": [
            {
                "endpoint_name": "getApps",
                "method": "get",
                "endpoint": "apps",
                "endpoints_custom_headers": [],
                "query_params": [],
                "incremental_value_response_field": "event",
                "log_filter_params_dataformat": "iso",
                "log_filter_params_from_value": "2023-10-05 11:13:47",
                "id": "bbf30918-8605-4f1f-8d7c-93ce3489d57e",
                "fetch_status": "",
                "last_fetch_attempt": ""
            }
        ],
        "RoutingPolicy": "651e49ad911faf6e24139ca4",
        "NormalizationPolicy": "651e49ad911faf6e24139ca3",
        "EnrichmentPolicy": "642beb329fab980b50e4bb7e"
    },
    "user": "642be720fad1d2b4e61f9773",
    "dc_metadata": {},
    "template": null,
    "last_log_received": null,
    "id": "651e49ad911faf6e24139ca5"
}

LogSources - List¶

List all log sources.

GET

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

Success Response

[
    {
        "name": "LogSource",
        "log_source_type": "UniversalRestApi",
        "vendor_name": "",
        "logo": "",
        "description": "",
        "documentation_link": "",
        "config": {
            "Source": {
                "name": "LogSource",
                "base_url": "https://10.45.9.123",
                "request_timeout": 30,
                "retry_after": 10,
                "interval": 30,
                "charset": "utf_8",
                "source_name": "06f148533e9ac62e268e91dd790a8cfb",
                "sid": "06f148533e9ac62e268e91dd790a8cfb|10.45.9.123",
                "identifier": null
            },
            "Connector": {
                "auth_type": "none",
                "custom_headers": [
                    {
                        "key": "id",
                        "value": "15"
                    }
                ],
                "enforce_https": true,
                "enable_proxy": false,
                "protocol": "http",
                "ip": "",
                "port": ""
            },
            "Endpoints": [
                {
                    "endpoint_name": "getApps",
                    "method": "get",
                    "endpoint": "apps",
                    "endpoints_custom_headers": [],
                    "query_params": [],
                    "incremental_value_response_field": "event",
                    "log_filter_params_dataformat": "iso",
                    "log_filter_params_from_value": "2023-10-05 11:13:47",
                    "id": "bbf30918-8605-4f1f-8d7c-93ce3489d57e",
                    "fetch_status": "",
                    "last_fetch_attempt": ""
                }
            ],
            "RoutingPolicy": "651e49ad911faf6e24139ca4",
            "NormalizationPolicy": "651e49ad911faf6e24139ca3",
            "EnrichmentPolicy": "642beb329fab980b50e4bb7e"
        },
        "user": "642be720fad1d2b4e61f9773",
        "dc_metadata": {},
        "template": null,
        "last_log_received": null,
        "id": "651e49ad911faf6e24139ca5"
    }
]

LogSources - ListLogSourceMetaData¶

Lists schema version of LogSource.

GET

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

Success Response

[
    {
        "SyslogCollector": {
            "schema_version": 0
        }
    }
]

LogSources - RefreshList¶

Syncs the current log source list with Logpoint’s log source list.

POST

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

Request Example

{
    "data": {}
}

Success Response

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

LogSources - Trash¶

Deletes the log source with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing log source to delete. Mandatory Field.

Success Response

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

Helpful?