Use Elastic APIs

Introduction

It may be helpful to use the available APIs to interact with the Operations CTRL Monitoring service to reduce complexity or connect from another application. This document will guide users to the API documentation and get them started using the available APIs

Elastic APIs:

Suggested Tools:

• Postman (Download Postman | Get Started for Free)

Overview

There are several APIs available to interact with the Operations CTRL Monitoring Service. The primary underlying tools are currently Kibana, Security, and Elasticsearch. 

In each case using Basic Authentication with a username and password can be used. In some cases, additional headers will be needed such as Kibana uses:

• kbn-xsrf: true
• Content-Type: application/json.

The user role will determine what endpoints are available. a description of the available roles is here:

• Built-in roles | Elasticsearch Guide [8.5] | Elastic 

Some individual API calls require additional headers

To create an API Key refer to this document 

• API Keys | Kibana Guide [8.5] | Elastic 

To work with the endpoints and APIs you can download and use Postman or navigate to Management --> Dev Tools in the Console.

If you choose to use Postman, be sure the URL begins with something like this:

• https://<kibana cluster id>.elastic.expedient.cloud:9243/api

The Dev Tools interface works differently and is described here:

• Run API requests | Kibana Guide [8.5] | Elastic

Kibana

Kibana is used as a frontend GUI to Elastic and Fleet. This includes, but is not limited to such things as spaces, users, saved objects, data views, index patterns (not indexes themselves, that is the Elastic API), and dashboards.

The documentation for the Kibana API is found here:

• REST API | Kibana Guide [8.5] | Elastic 

Security

Security manages and organizes users, roles, role mappings, application privileges, tokens, and API keys.

The documentation for the Security API is found here:

• Elastic Security APIs | Elastic Security Solution [8.5] | Elastic

Elasticsearch

Elasticsearch manages and organizes the data so it is available and quick. This includes, but is not limited to search, index, enrich, data streams, rollup, machine learning, and ingest.

The documentation for the Elasticsearch API is found here:

• REST APIs | Elasticsearch Guide [8.5] | Elastic