Understanding the /health API Endpoint – IriusRisk Support

IriusRisk /health API endpoint is crucial to our customers as it quickly lets them know the current status of the entire application, ranging from license details all the way to determining if a service is up, or down.

To query your health endpoint you can simply use your browser and type:

https://<DNS>.iriusrisk.com/health

Other useful methods for querying the health endpoint include cURL - The Linux utility or a GUI application like Postman or Insomnia - For details on how to set up the GUI application with IriusRisk API please see the below articles:

Set Up Insomnia

Set Up Postman

An example of a cURL command is as follows:

$ curl -s https://<DNS>.iriusrisk.com/health

The cURL command will return a response, and this will show us various different pieces of crucial information. Below is a response:

{
    "company": "<DNS>",
    "validDate": "2023-11-11",
    "status": "200",
    "licenseText": "Licensed to <DNS> for 100 projects",
    "appLimit": 100,
    "version": "4.18.1-0-g2e2018a05c-02/08/23 10:32",
    "database": "OK",
    "ui": "OK",
    "apiVersion": "1.23.0",
    "services": {
      "startleft": "UP"
      }
}

There are various different components to this response, but as seen above it is highly informative details about the application. The different component of this response is described below:

company: This is your company name/DNS
validDate: This is date your IriusRisk license expires
status: This is the response code of the request
licenseText: Describes the amount of projects associated with the license and DNS
appLimit: numerical value for projects associated with the license
version: This is the current application version that IriusRisk is running
database: This is a check to tell whether the database is up and running
ui: This is a check to tell whether the user inferface is up and running
apiVersion: The version of the API installed on the system
startleft: This is a check to determine the state of startleft

For further information on our API then feel free to visit Swaggerhub.

Related articles