OHS health check with APIs

Health checks on the On-premises Hybrid Service (OHS) may be initiated and viewed remotely by making API calls to the Hybrid Connector Configuration Gateway, in addition to using the OHS Configuration user interface. This section describes the process for using the Configuration Gateway API to monitor the operational health of OHS in production or lower environments.

The general process is as follows:

  1. Get the access token for all API calls.

  2. Get OHS instance details for a given tenant.

  3. Initiate a health check for a specific OHS instance.

  4. Get specific OHS instance health check details, get all of the OHS instances health details for a tenant, or get health check results for multiple tenants.

Note: In the examples described here, passwords, and the like are shortened or changed for security and privacy reasons. Variables that need to be passed by the requesters are indicated with brackets ({}).

The following table lists the specific URLs required to call the various APIs based on the environment.

Environment IHC Config Gateway URL Iden Server URL
Prod-USW https://k8s.itrontotal.com/ihcconfiggateway/api/v1 https://idenserver.itrontotal.com/connect/token
Prod-EUN https://k8s.itroneyva.eu/ihcconfiggateway/api/v1 https://idenserver.itroneyva.eu/connect/token

The API examples shown in this document use the URLs for the Prod-USW environment.

Important! An OHS Health Check can be system initiated or user initiated. System-initiated checks are called Automated Health Checks and may run under one of the following conditions:

  • During configured intervals as defined in the appsettings.json file under OHS Management Service (AutomatedHealthCheckIntervalInHours)
  • After a successful configuration update (Reset Configuration)

All users with the Tenant Admin role will be sent an email alert when an automated health check fails. See Health check email alerts.

The topics within this section provide details about using APIs for OHS health checks: