Health Check

Description

The health check reports if the responding Portal for ArcGIS machine is able to receive and process requests. For example, before creating the portal, the health check URL reports the site is unavailable because it can't take requests at that time.

This endpoint is useful if you're setting up a third-party load balancer or other monitoring software that supports a health check function.

A healthy (available) portal machine will return an HTTP 200 response code along with an HTML page indicating the portal machine is ready. An unhealthy (unavailable) portal machine will return messaging other than HTTP 200.

Request Parameters

Parameter

Details

f

Description: The response format. The default response format is html.

Values: html | json

Example Usage

https://myportal.esri.com/portal/portaladmin/healthCheck

JSON Response Syntax

Even when JSON is requested, if the portal is unhealthy, an html response is returned. If the portal is available, a JSON status of success is returned.

{"status": "success"}

JSON Response Example

{"status": "success"}

3/3/2017