Search API

getalloweddata

You can retrieve information about your Logpoint using getalloweddata. It has five API actions and two mandatory parameters which is required for authorization and authentication. It includes an additional parameter, type, which specifies the type of information to be retrieved from Logpoint.

• username : Logpoint username for authorization and authentication

• secret_key : Access key to uniquely identify an authorized user.

• type — An identifier for the API action.

Parameters need to be included in the request body as application/x-www-form-urlencoded.

While the following endpoints use the POST method, they function as GET.

Endpoint	Request Type	Parameter	Query String
Get User Timezone	POST	type	user_preference
Get Logpoint	POST	type	loginspects
Get Repos	POST	type	logpoint_repos
Get Devices	POST	type	devices
Get Livesearches	POST	type	livesearches

Get User Timezone

To retrieve timezone and date and time format.

POST

https://Logpoint-IP/getalloweddata

Request Parameters

• Should be included in the request body as application/x-www-form-urlencoded.

• type = user_preference

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "type" : "user_preference"
}

Request Example

cURL

curl --location 'https://10.45.10.172/getalloweddata' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'type=user_preference'

Success Response Example

{
    "success": true,
    "timezone": "UTC",
    "date_format": "%Y/%m/%d",
    "hour_format": "24 Hour"
}

Response Parameters

Response Parameters	Value Type	Description
success	Boolean	True if successful; False if unsuccessful
timezone	String	Returns user's timezone applied in their user preferences.
date_format	String	Returns format applied in their user preferences. The format %Y/%m/%d represents the date as a four-digit year, month, and day separated by slashes. (Example: 2024/09/18)
hour_format	String	Returns format according to their user preferences.

Get Logpoint

Retrieves name and IP address of all Logpoint instances or servers in a distributed setup.

POST

https://Logpoint-IP/getalloweddata

Request Parameters

• Should be included in the request body as application/x-www-form-urlencoded.

• type = loginspects

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "type" : "loginspects"
}

Request Example

cURL

curl --location 'https://10.45.10.172/getalloweddata' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'type=loginspects'

Response Parameters

Parameter	Value Type	Description
success	Boolean	True if successful; False if unsuccessful
allowed_loginspects	String	Returns a list of Logpoint instance or server names and their IP addresses.

Success Response

{
    "success": true,
    "allowed_loginspects": [
        {
            "name": "Logpoint",
            "ip": "127.0.0.1"
        }
    ]
}

Getting Repos

To retrieve name and IP address of all repos.

POST

https://Logpoint-IP/getalloweddata

Request Parameters

• Should be included in the request body as application/x-www-form-urlencoded.

• type = logpoint_repos

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "type" : "logpoint_repos"
}

Request Example

cURL

curl --location 'https://10.45.10.172/getalloweddata' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'type=logpoint_repos'

Success Response

{
    "success": true,
    "allowed_repos": [
        {
            "repo": "default",
            "address": "127.0.0.1:5504/default"
        },
        {
            "repo": "_Logpoint",
            "address": "127.0.0.1:5504/_Logpoint"
        }
        ....
    ],
    "Logpoint": [
        {
            "name": "Logpoint",
            "ip": "127.0.0.1"
        }
    ]
}

Response Parameters

Response Parameters	Value Type	Description
success	Boolean	True if successful; False if unsuccessful
allowed_repos	Array	List of names and IP addresses of all repos.

Get Devices

Retrieves the names and IP addresses of all devices.

POST

https://Logpoint-IP/getalloweddata

Request Parameters

• Should be included in the request body as application/x-www-form-urlencoded.

• type = devices

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "type" : "devices"
}

Request Example

cURL

curl --location 'https://10.45.10.172/getalloweddata' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'type=devices'

Success Response

{
    "success": true,
    "allowed_devices": [
        {
            "127.0.0.1/127.0.0.1": "localhost",
            "127.0.0.1/::1": "localhost",
            "127.0.0.1/10.45.3.107": "107"
        }
    ],
    "Logpoint": [
        {
            "name": "Logpoint",
            "ip": "127.0.0.1"
        }
    ]
}

Response Parameters

Response Parameters	Value Type	Description
success	Boolean	True if successful; False if unsuccessful
allowed_devices	Array	Returns a list of the names and IP addresses of all devices

Get Live Searches

Retrieves live search results.

POST

https://Logpoint-IP/getalloweddata

Request Parameters

• Should be included in the request body as application/x-www-form-urlencoded.

• type = livesearches

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "type" : "livesearches"
}

Request Example

cURL

curl --location 'https://10.45.10.172/getalloweddata' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'type=livesearches'

Successful Response

{
    "success": true,
    "livesearches": [
        {
            "searchname": "device_ip",
            "description": "",
            "query": "| chart count() by device_ip",
            "query_info": {
                "fieldsToExtract": [],
                "aliases": [
                    "count()"
                ],
                "success": true,
                "query_filter": "",
                "columns": [
                    "count()"
                ],
                "query_type": "chart",
                "lucene_query": "",
                "grouping": [
                    "device_ip"
                ]
            },
            "timerange_day": 0,
            "timerange_hour": 0,
            "timerange_minute": 1,
            "timerange_second": 0,
            "limit": 100,
            "tid": "",
            "generated_by": "dashboard",
            "vid": "",
            "flush_on_trigger": false,
            "life_id": "3287dec3b4012b50f63e15fd6cbe6f77dc56aa4b"
        }
    ]
}

Response Parameters

Response Parameters	Value Type	Description
success	Boolean	True if successful; False if unsuccessful
livesearches	Array of objects	Returns an array of live search details
searchname	String	Name of the live search.
description	String	Information about the live search
query	Object	Search query
query_info	String	Search query metadata, including extracted fields, aliases, filter criteria, and query type.
fieldsToExtract	Array of strings	Lists fields extracted from the data during the live search.
aliases	Array of strings	Aliases used in the search query, if any.
query_filter	String	Any filters applied to the query.
columns	Array of strings	Lists the columns returned by the query, such as count().
query_type	String	Defines the type of query executed (for example: chart).
lucene_query	String	Any Lucene query filters applied to the data.
grouping	Array of strings	The fields used to group the search results. For example: device_ip.
timerange_day	Integer	The day range of the live search data.
timerange_hour	Integer	The hour range of the live search data.
timerange_minute	Integer	The minute range of the live search data.
timerange_second	Integer	The second range of the live search data.
limit	Integer	Defines the maximum number of results.
tid	String	Task ID associated with the live search, if applicable.
generated_by	String	Origin of the live search, such as dashboard.
vid	String	View ID associated with the live search, if applicable.
flush_on_trigger	Boolean	Whether to flush on trigger.
life_id	String	A unique identifier associated with the live search session.

getsearchlogs

To get search results using Logpoint Search API, perform a search request with all required parameters. A successful request responds with a search_id can be used as a request parameter to receive logs resulting from the search query request.

While the following endpoints use the POST method, they function as GET.

Required Parameters

Parameter	Value Type	Description
query	String	A valid search query
time_range	String	Default search time range
repo	Array/List	Where the logs are stored
client_name	String	Interface of the search request. The default value is ‘UI’.
timeout	Integer	Waiting time (in seconds) for a request before canceling it.
search_id	String	Used to get logs of a search query. You receive it from the server only after the successful completion of a search request.
limit	Integer	The maximum amount of search results. Only applicable in case of simple search queries and not in case of aggregation queries.

Request search_id

This API request retrieves the search_id to perform a query-based search on designated repos for a limited number of logs within a defined time range.

POST

https://Logpoint-IP/getsearchlogs

Request Parameters

• Included in the request body as application/x-www-form-urlencoded.

• Content-Type, Content-Length, and Host must be passed in the request header.

• Content-Type should be application/x-www-form-urlencoded.

• requestData — a list of JSON objects containing:

  • query: A valid Logpoint search query

  • time_range: A time range for the search

  • limit: The number of search results

  • repos: IP address of the repos

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "requestData": {
        "query": "|chart count() by device_ip",
        "time_range": "Last 24 hours",
        "limit": 100,
        "repos": ["127.0.0.1:5504/_Logpoint"]
    }
}

Request Example

cURL

curl --location 'https://10.45.10.172/getsearchlogs' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'requestData={"query": "|chart count() by device_ip", "time_range": "Last 24 hours", "limit": 100, "repos": ["127.0.0.1:5504/_logpoint"]}'

Successful Response

{
    "search_id": "23b4a5fd-d419-4831-bcf5-e6846857fb64",
    "client_type": "UI",
    "query_filter": "",
    "latest": false,
    "lookup": false,
    "query_type": "chart",
    "time_range": [
        1582023872,
        1582110272
    ],
    "searchId": "23b4a5fd-d419-4831-bcf5-e6846857fb64",
    "clientType": "UI",
    "success": true
}

Response Parameters

Response Parameters	Value Type	Description
search_id	String	A unique identifier generated for the search
client_type	String	Type of client that initiated the request.
query_filter	String	Specifies any filters applied to the query.
latest	Boolean	True if the search fetches the latest logs; False if not
lookup	Boolean	True if the search includes a lookup operation; False if not
query_type	String	Defines the type of query executed (Example: chart).
time_range	Array of integers	Contains two timestamps that define the start and end of the search time range.
success	Boolean	True if successful; False if unsuccessful

Get Search Logs

Retrieves logs from a specific search based on the search_id. The server sends the search result logs in chunks. Continue sending the request with the same parameters until you receive a response where final is equal to true. This means you received all the search result logs.

POST

https://Logpoint-IP/getsearchlogs

Request Parameters

• Should be included in the request body as application/x-www-form-urlencoded.

• requestData — a JSON object containing the unique search_id.

{
    "username" : "John",
    "secret_key" : "a1b2c3d4e5f6g7h8i9j0k1",
    "requestData": {
        "search_id": "23b4a5fd-d419-4831-bcf5-e6846857fb64"
    }
}

Request Example

cURL

curl --location 'https://10.45.10.172/getsearchlogs' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=John' \
--data-urlencode 'secret_key=a1b2c3d4e5f6g7h8i9j0k1' \
--data-urlencode 'requestData={"search_id": "23b4a5fd-d419-4831-bcf5-e6846857fb64"}'

Success Response

{
    "num_aggregated": 12345,
    "columns": [
        "count()"
    ],
    "query_type": "chart",
    "rows": [
        {
            "device_ip": "::1"
            ...
        },
        {
            "device_ip": "127.0.0.1"
            ...
        }
    ],
    "grouping": [
        "device_ip"
    ],
    "version": 2,
    "interesting_fields": [],
    "time_range": [
        1582024214,
        1582110614
    ],
    "orig_search_id": "23b4a5fd-d419-4831-bcf5-e6846857fb64",
    "success": true,
    "final": true,
    "totalPages": 1,
    "complete": true,
    "showAdditionalPanels": true,
    "status": {
        ...
    }
}

Response Parameters

Response Parameters	Value Type	Description
num_aggregated	Integer	The total number of logs aggregated in the result set.
columns	Array of strings	Lists the columns returned by the query, such as count().
query_type	String	Defines the type of query executed.
rows	Array of objects	Search results. Each object represents a log entry with relevant fields, for example device_ip.
grouping	Array of strings	Defines which fields group search results, for example device_ip.
version	Integer	Version of the search result format or API being used.
interesting_fields	Array of strings	Lists any fields deemed interesting in the result set.
time_range	Array of integers	Contains two timestamps that define the start and end of the search time range.
orig_search_id	String	The original search_id used to initiate the search.
final	Boolean	Returns true if all search result logs are retrieved; otherwise false.
success	Boolean	Returns true if the API call is successful; otherwise false.
totalPages	Integer	The total number of pages of results.
complete	Boolean	Returns true if the search is successful; otherwise false.
showAdditionalPanels	Boolean	Returns true if additional visualizations should be displayed with the search result; otherwise false.
status	object	Additional status information about the search, such as progress or execution details.