Skip To Content
ArcGIS Developer

Health Check

  • URL:https://<root>/healthCheck
  • Version Introduced:10.4


The healthCheck resource reports if the responding Portal for ArcGIS machine is able to receive and process requests. For example, before creating the portal, healthCheck may report the site is unavailable because it can't take requests at that time. An available portal machine will return an HTTP 200 response code along with an page indicating the portal machine is ready. An unavailable portal machine will return messaging other than HTTP 200. If a machine is unavailable, even if format (f) is set as json or pjson, the response will return an HTML page. This resource is useful for setting up a third-party load balancer or other monitoring software that supports a health check function.

Request parameters


The response format. The default response format is html.

Values: html | json

Example usage

The following is a sample request URL for the healthCheck resource:

The following sample request URL demonstrates accessing the healthCheck resource over port 7443, rather than through a site configured with a web adaptor:

JSON Response example

{"status": "success"}