Accessing the Monitoring API

Access the eperi sEcure Platform's Monitoring API.

Before you begin

  • You will need an Admin User which has the right to access the Monitoring API.
  • We recommend creating a dedicated Monitoring User for this purpose.

About this task

Using external tools, this Monitoring API can be called and will deliver current information to the calling party, such as the Proxy status and the Licensing status of the eperi sEcure Platform.

Procedure

  1. Use the following endpoint 
    /api/info/monitor
  2. Authenticate using the user from the Prerequisites-section above

Results

The Monitoring API delivers current and relevant information with regards to the eperi sEcure Platform's health status in JSON format.