- URL:
- https://<root>/info/healthcheck
- Methods:
GET- Version Introduced:
- 12.0
Description
The healthcheck operation outputs a boolean based upon whether the health check passes or not. If the health check fails, it will output an error message.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The output format for this operation. The default value is Values: |
(Required) | Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation. |
Response properties
| Property | Details |
|---|---|
| Outputs the results of the Health Check operation. If healthy, it will say that the site is ready and the check was successful. Values: |
Example usage
The following is a sample request URL used to access the health resource:
https://organization.example.com:21443/arcgis/rest/info/healthcheck?f=pjsonJSON Response syntax
{
"success": "<true | false>"
}JSON Response example
{
"success": "true"
}