Skip to content
URL:
https://<root>/healthCheck
Methods:
GET
Operations:
Run
Child Resources:
Suites, Reports
Version Introduced:
11.2

Access requirements

Required privileges

The Enterprise 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 Enterprise 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 generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

The healthCheck resource provides access to the Suites and Reports resources, as well as the Run operation. These endpoints help administrators monitor the health of their organization. The htmlCheck resource only supports a HTML output.

Request parameters

ParameterDetails

f

The response format. The only supported format is html.

Example usage

The following is a sample request URL used to access the healthCheck resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/healthCheck

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