The database is a critical resource that needs to remain healthy for the entire lifespan of any application, and this is the same with IriusRisk. This means that customers deployed on-premise or in the cloud need to have a stable database, and it must remain durable and the uptime of the resource is crucial.
IriusRisk have developed an endpoint to allow users to query the health of the database, and ensure it is functioning as desired - This endpoint can be useful for routine health checks, automations and other business functions.
What Is The Endpoint?
The endpoint to query the database health is shown below:
To find out more information on this endpoint, and many other please check SwaggerHub.
How Can I Query The Endpoint?
To query your database endpoint you can simply use your browser and type:
A GUI application like Postman or Insomnia can be used to query the database endpoint - For details on how to set up the GUI application with IriusRisk API please see the below articles:
An example of a cURL command is as follows:
$ curl -s https://<DNS>.iriusrisk.com/health/db
The cURL command will return a response, and this will show us various different pieces of crucial information. Below is a response:
As the above output suggests, the database is up and healthy. A status code of 200 means the database is working as intended, if you receive any other status code then this would need investigated.