Health Check

URL:: https://notebookserver.domain.com:11443/arcgis/rest/info/healthcheck
Methods:: GET
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.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

Response properties

Property Details

Property	Details
`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`

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

Use dark colors for code blocksCopy
https://gisserver.domain.com:11443/arcgis/rest/info/healthcheck
f=json

JSON Response syntax

Use dark colors for code blocksCopy
{"success": "true|false"}

JSON Response example

Use dark colors for code blocksCopy
{"success": "true""