Run (Health Check Reports) | ArcGIS REST APIs

URL:: https://<root>/healthCheck/run
Methods:: POST
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.

Security and infrastructure

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 run operation performs a health check using suites specified by an administrator and generates a health check report. A suite is a grouping of predefined tests that are performed against the organization during a health check. Administrators can run a basic health check suite, which validates the overall health for an organization, and at ArcGIS Enterprise on Kubernetes 12.0, administrators also run an operational health check suite, which provides insights into and detects potential issues with operational efficiency. For more information, see the Suites documentation.

This operation can be performed asynchronously. If performed asynchronously, the request will return a job ID. The HTML view redirects to the requests job page. Otherwise, to access the job resource you can make a request of the following form:

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

Request parameters

Parameter	Details
`suiteIds` (Required)	A comma-separated list of suite IDs, specifying which suites are used during the health check. Administrators have access to a basic health check (`BSHC-001`) and operational health check (`OHC-001`) introduced at 12.0. The suite IDs can be retrieved from the Suites resource. Example Use dark colors for code blocksCopy `1 suiteIds=BSHC-001`
`runName` (Required)	A user-specified name for the report. Example Use dark colors for code blocksCopy `1 runName=report-test`
`retentionDate` (Optional)	Introduced at 11.4. The date, in epoch milliseconds, when the backup will be eligible for cleanup by a system task. Note Assigning a value of -1 to `retentionDate` will cause the backup to never expire, meaning that it will never be cleaned by the `backupRetentionCleaner` task. Not assigning a value to this parameter will automatically set the `retentionDate` value to -1. Example Use dark colors for code blocksCopy `1 retentionDate=1635945710988`
`async` (Optional)	Specifies whether the operation is performed synchronously or asynchronously. If performed synchronously (`false`), the operation returns portion of a URL that be appended to the Health Check resource URL to access the report. Performing the operation synchronously may take some time. If performed asynchronously (`true`), the operation returns a `jobsUrl` that can be used to check the status of the operation. The default value is `false`. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is sample POST request for the run operation:

Use dark colors for code blocksCopy
POST /<context>/admin/healthCheck/run HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

suiteIds=BSHC-001,OHC-001&runName=report-test&retentionDate=1635945710988&async=true&f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

JSON Response examples

The following JSON response is returned when the operation is performed asynchronously. Appending the statusURL to the Health Check resource URL will redirect to the report.

Use dark colors for code blocksCopy
{
  "statusURL": "/<context>/admin/healthCheck/reports/x7iv8phn1f"
}

The following JSON response is returned when the operation is performed asynchronously. Using the provided job URL will redirect to the job page for the report, which can be occasionally polled to check the status of the job.

Use dark colors for code blocksCopy
{
  "jobsUrl": "https://organization.example.com/<context>/admin/jobs/j62f4691f-162d-4f1a-be62-7365e44a8549",
  "jobid": "j62f4691f-162d-4f1a-be62-7365e44a8549",
  "status": "SUBMITTED"
}

The following are sample reports returned by the job resource once the job has completed:

Basic health check report example

Operational health check report example

Use dark colors for code blocksCopy
{
  "result": {
    "diagnosticHealthReport": {
      "owner": "user",
      "suiteStatus": [
        {
          "result": {
            "failCount": 0,
            "totalCount": 13,
            "passCount": 13,
            "skippedOrNotApplicableCount": 0
          },
          "criticalTestStatus": [
            {
              "result": "pass",
              "name": "sharing_availability",
              "description": "Portal API endpoint is available",
              "startTime": 1762248877615,
              "id": "HC_112_001",
              "endTime": 1762248877672,
              "state": "completed",
              "category": "critical"
            }
          ],
          "name": "Basic health checks",
          "description": "Conducts a suite of functional and availability health checks to validate overall organization health.",
Expand