API to check Saviynt instance Status

[Anurag]

We are looking for a way to check the current status of our saviynt instance by using Rest API, if the instance is running or its down. This is to ensure that the saviynt instance is running before we call any of the other Saviynt native APIs.

we came across {{url}}/ECM/{{path}}/testConnection API, but this seems to be for testing db connection.

Please let me know if anyone is aware of such native API to check health status of Saviynt instance.

Thanks

[rushikeshvartak]

You can raise saviynt freshdesk ticket they monitor saviynt status using datadog

[Anurag]

Hi Rushikesh,

Any way to check this status using native REST API?

Thanks

[rushikeshvartak]

You can hit login API if that’s reachable then server is up else not

[Anurag]

The requirement we have requires to check the status of saviynt instance before even logging in to saviynt, so at this point we won't be sending the username/password to saviynt.

A url like below to check the health status will be needed.

https://XXX.saviyntcloud.com/ECM/healthcheck

[rushikeshvartak]

Currently there are no api provided by saviynt

https://documenter.getpostman.com/view/1797923/2s83mbojGM

you can request this as feature on saviynt ideas portal https://ideas.saviynt.com/ideas

[Enakshi]

Just want to understand what would be the problem if you call login API by sending username/password.

[Anurag]

we are not sure what will be the response of login api when the saviynt instance is down also the internal checks saviynt will do for username/password will add up extra time in the total response time compared to having a dedicated endpoint for checking status of Instance. 

Aso we login once and use the generated token in subsequent api calls, but if we use login api for status check we will be calling the login api multiple times in short intervals not sure what would be the impact of that.

[sk · Accepted solution]

We have similar requirement and when we checked with Saviynt we got below URL which provides status of Saviynt components in JSON format without any authentication but it is not very helpful for our requirement. See if it helps you in your use case.

https://<base-url>/ECM/login/healthcheck

And below is the output it looks like

{"checks":{"DB_Health":{"status":"pass","errorcode":"NA","message":"DB Service is up"},"ES_Health":{"status":"pass","errorcode":"NA","message":"Elastic server is up"}},"description":"Health of ECM service","status":"pass","timestamp":"12-22-2022 17:47:31"}

[Anurag]

I think we can use this endpoint for our use case but this link is not accessible for us. Getting below error when we try out the above url.  

Do we have to enable this endpoint from somewhere ?

[rushikeshvartak]

It must be from v2020 onwards