Skip To Content
ArcGIS Developer
Dashboard

Health Check

  • URL:https://notebookserver.domain.com:11443/arcgis/rest/info/healthcheck
  • Version Introduced:10.9

Description

The healthcheck operation verifies that the ArcGIS Notebook Server site has been created and that its Docker environment has been correctly configured. If the health check fails, you cannot communicate with Notebook Server using the web adaptor endpoint.

Note:
When upgrading ArcGIS Notebook Server to a new version, the health check will fail until all of the necessary upgrade steps are completed. See Upgrade ArcGIS Notebook Server for more information.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails
success

Indicates whether the health check found the site to be sufficient or insufficient. If the value is false, either the site has not been created or the Docker environment has not been correctly configured.

Values: true | false

Example usage

https://gisserver.domain.com:11443/arcgis/rest/info/healthcheck
f=json

JSON Response syntax

{"success": "true|false"}

JSON Response example

{"success": "true""