Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Note: For details on SPM API, see SPM API Reference.

Introduction to Management API

Logsene HTTP API is used to easily manage and access your Logsene Apps and their data remotely, without the need to be logged-in via a browser. It also makes it possible to automate certain tasks, such as creation of new Apps, definition of Alert Rules, etc.

To use the management APIs, you need the API key for your Account (or, if you are a guest to some other Account under which you want to manage Apps, Alerts..., then API key of that Account) - it can be found here. API key needs to be passed as an attribute to all API calls and is used by Logsene to authenticate Account under which some API call is done.  API keys and App tokens used in this document are fake.  Use your own API key and App tokens.

Access to API key of some Account is allowed for OWNERBILLING_ADMIN and ADMIN users. Users with USER role cannot access API key of that Account, though they can always use their own Account's API key to manage their own Account, Apps, etc.  For more info about Account Sharing please see SPM FAQ.

Elasticsearch-compatible Search API

To use the search APIs, which are described here and are see Search through the Elasticsearch API. This API is fully compatible with Elasticsearch's APIs, you will . To use it you need just your Logsene App tokens, not the API key.  The rest of this document describes only the app management APIs.  For Elasticsearch-compatible API see thissearching your logs from the terminal/console, see Logsene CLI.

Request/Response format

All API calls accept JSON in requests and return JSON response. All API call requests should contain apiKey attribute (among other attributes specific for that API call). Example of content of one such call:

...