I am not sure how broadly known the topic of this post already is, so this might be a boring one: How can you tell if a Business Central (and NAV) service tier and web client are healthy or not? I got the question and had to agree that it isn’t documented anywhere. My first inclination was to add something to the excellent Business Central docs, but I couldn’t identify a good place, so I decided to just write a quick blog post

The TL;DR

It actually is very simple. Assuming that your web client is running on a server called “mywebserver”¹ and the instance name is “mybcinstance”, then the URL for your web client would be https://mywebserver/mybcinstance. Checking for the health state of this web client and service tier is as easy as a GET call to https://mywebserver/mybcinstance/health/system. If everything is fine, you get result=true as you can see here

1
2
3
4
5
6
7
8
9
10
11
12
13
GET https://mywebserver/mybcinstance/health/system

HTTP/1.1 200 OK
...
Content-Type: application/json; charset=utf-8
Date: Fri, 25 Sep 2020 08:53:39 GMT
...
Content-Length: 35
Connection: close

{
  "result": true
}

And what about the older versions?

At some point (I think NAV 2018, but am not sure) Microsoft introduced the new path for he web client that you see above. Before that it used to be https://mywebserver/mybcinstance/WebClient, so the health check URL for those oder versions is https://mywebserver/mybcinstance/WebClient/health/system

That’s it :)