Health Check

URL:
https://<host>/<instance>/rest/info/healthcheck
Methods:
GET
Version Introduced:
10.1

Description

The health check reports whether the responding machine in the ArcGIS Server site is able to receive and process requests. For example, during site creation, this URL reports the site is unhealthy 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) site will return an HTTP 200 response code along with a message indicating "success": true (noted below). An unhealthy (unavailable) site will return messaging other than HTTP 200.

Request parameters

ParameterDetails

f

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

Values: html | json

Example usage

1
https://machine.domain.com/webadaptor/rest/info/healthcheck

JSON Response syntax

1
{"success": <true | false>}

JSON Response example

1
{"success": true}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close