How Can We Help?

You can extend Heal-based solutions using the APIs. Heal contains many pre-built APIs and you can use it to suit your requirements. For instance, performance metric data collected by bespoke applications can be ingested into Heal. To auto-generate tickets in ticketing tools like ITSM when an anomaly occurs, Action APIs come into play.

APIs

Heal groups the APIs based on the functionality. We recommend you to read the Heal Basics, to get familiar with the essentials of Heal.

  • Topology API
  • Ingestion API
  • Action API
  • Query API

Topology API

Topology API is the base API and all the basic entities and relationships of Heal can be created. These are Rest-based APIs.

Ingestion API

You may be collecting or monitoring the time-series data by any bespoke application or custom agents. Ingestion API allows you to send these data to Heal via Ingestion APIs. These are Protocol Buffer (Protobuff) based APIs.

Action API

Action APIs generated the MLE triggers. You can integrate the ticketing tools, notification tools via Action APIs. These are Rest based APIs.

Query API

Plugin for popular dashboards is available via Query APIs. These are Rest based APIs.

Table of Contents