Suites

URL:
https://<root>/healthCheck/suites
Methods:
GET
Child Resources:
Suite
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
11.2

Description

The suites resource returns a list of all suites that administrators can use to generate health check reports for their organization. Each 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.

Along with the list of suites, this resource returns the tests included in each suite that will be performed during a health check, as well as the suite's ID, which is used to run a health check.

Request parameters

ParameterDetails

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 suites resource:

1
https://organization.domain.com/context/admin/healthCheck/suites?f=pjson

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
  "userSuites": [
    {
      "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"
    }
  ]
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close