- URL:
- https://<root>/healthCheck
- Methods:
GET- Version Introduced:
- 10.4
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The health resource reports if the responding Portal for ArcGIS machine is able to receive and process requests. For example, before creating the portal, health may report the site is unavailable because it can't take requests at that time. An available portal machine will return an HTT response code along with an page indicating the portal machine is ready. An unavailable portal machine will return messaging other than HTT. If a machine is unavailable, even if format (f) is set as json or pjson, the response will return an HTML page. This resource is useful for setting up a third-party load balancer or other monitoring software that supports a health check function.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usages
The following is a sample request URL used to access the health resource:
https://organization.example.com/<context>/portaladmin/healthCheck?f=pjsonJSON Response example
{"status": "success"}