Suite

• URL:https://<root>/healthCheck/suites/suite
  
• Required Capability: Default administrator role | Security and infrastructure
• Version Introduced:11.2

Description

This 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 cannot change the tests or choose which tests are performed from a specific suite. At ArcGIS Enterprise 11.2 on Kubernetes, administrators have access to a basic health check suite. Basic health check reports conduct a suite of functional and availability health checks to validate overall organization health.

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
f	The response format. The default format is html. Values: html | json | pjson

Example usage

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

https://organization.domain.com/context/admin/healthCheck/suites/BSHC-001?f=pjson

JSON 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"
}