- URL:
- https://<root>/healthCheck/suites/suite
- Methods:
GET- 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 generate 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.
Description
The suite resource returns the name of, and short description for, the tests included in a specific suite. A suite is a grouping of predefined tests that are performed against the organization during a health check. Administrators have access to a basic health check suite and, starting at ArcGIS Enterprise on Kubernetes 12.0, an operational health check suite.
More detailed test information is returned by the Suites resource. Both suite-related resources return a suite ID, which is used to run a health check, export a health check report, or delete a health check report.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the suite resource:
https://organization.example.com/<context>/admin/healthCheck/suites/BSHC-001?f=pjsonJSON Response example
{
"systemOnly": false,
"generalTests": [
{
"name": "healthcheck_objectStore",
"description": "Object store health check"
},
{
"name": "home_app_availability",
"description": "ArcGIS Enterprise portal endpoint is available"
},
{
"name": "manager_availability",
"description": "ArcGIS Enterprise Manager endpoint is available"
},
{
"name": "healthcheck_spatioTemporalIndexStore",
"description": "Spatio temporal and index store health check"
},
{
"name": "healthcheck_ingress",
"description": "Ingress health check"
},
{
"name": "healthcheck_publishingService",
"description": "System publishing tools health check"
},
{
"name": "healthcheck_sharedMapService",
"description": "Shared map services health check"
},
{
"name": "healthcheck_spatialanalysis",
"description": "Spatial analysis service health check"
},
{
"name": "healthcheck_geometryService",
"description": "Geometry service health check"
},
{
"name": "query_logs_availability",
"description": "Can query logs"
},
{
"name": "healthcheck_index_synced",
"description": "Users, groups, and items indices are in sync"
}
],
"name": "Basic health checks",
"description": "Conducts a suite of functional and availability health checks to validate overall organization health.",
"criticalTests": [
{
"name": "sharing_availability",
"description": "Portal API endpoint is available"
},
{
"name": "healthcheck_relationalDatastore",
"description": "Relational store health check"
}
],
"id": "BSHC-001"
}