Logpoint API Reference

Logpoint APIs let you interact directly with its functionalities. It exposes the following APIs:

Search API

Search API endpoints enable you to search for logs and retrieve search information. You can retrieve information related to user timezone, Logpoint, devices, and repos from the Logpoint servers.

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.

Alert Rule API

Alert Rule APIs enable you to configure alert rules across multiple Logpoints. These APIs also allow you to set up email and HTTP notifications, view repos and distributed Logpoint instances, and access lists.

Accessing the APIs

Logpoint APIs comply 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 REST client browser to request information and receive responses from the servers. You can also implement custom features using HTTP libraries of programming languages to access the APIs.

Authorization and Authentication

To access Search API and Alert Rule API, you require two request parameters:

  • username: Logpoint username. Your API access depends on your user role in Logpoint.

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

For Alert Rule API, go to Accessing the Logpoint APIs.

Finding the Access Key

To find the access key, click the user icon in the navigation bar of Logpoint and select My Preferences. Your access key is displayed in API Access Key.

_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