LogPoint API Reference

LogPoint APIs lets you interact directly with the system functionalities. Currently, LogPoint exposes the following two APIs:

Search API

Search API endpoints enable you to search for logs and retrieve search information. You can retrieve information related to user timezone, LogPoints, devices, and repos from the LogPoint servers. These information are required as parameters when performing a search using the Search API.

Incident API

Incident API endpoints enable you to perform incident related actions and retrieve incident information. You can retrieve information like incident id, incident states, incident user name, and incident user groups. These information are required to perform incident actions.

Accessing the APIs

LogPoint APIs complies with the Representational State Transfer (REST) architectural style. It facilitates retrieving information from the endpoints exposed using the HTTP protocol. LogPoint APIs work on the Request-response principle. You can use the cURL tool or any REST client browser to request information and receive responses from the servers. You can also implement custom features by accessing the APIs using HTTP libraries of programming languages.

Authorization and Authentication

For authentication and authorization, the LogPoint APIs require two request parameters:

  • username, which includes a LogPoint username. Your access control for using the APIs is the same as your user roles in the system

  • secret_key, which is the access key to uniquely identify you as an authorized user.

Finding the Access Key

To find the access key, click the User icon in the sidebar and select My Preferences.

_images/LogPoint_Preferences_Dropdown.png

My Preferences

Your access key is displayed in the API Access Key section.

_images/LP_Pref_Key.png

API Access Key

Supported Format

LogPoint APIs support JSON with UTF-8 encoding. You can forward either a JSON array or a JSON object in a request. The request methods supported are POST and GET methods. The output response is always a JSON object.


Helpful?

We are glad this guide helped.


Please don't include any personal information in your comment

Contact Support