Develop > Service Health > Service Health External APIs > Reset Health Indicator State API

Reset Health Indicator State API

In certain event flows, you might have an HI showing that a problem has occurred but no event has closed the problem, even though the problem was fixed. After dealing with the problem, you might want to reset the HI's state to Normal (default). For details on resetting HI state within Service Health, see Health Indicators Component.

The Reset HI State API enables users outside of the OMi user interface to reset event-based HIs to their default state, using the HTTP-based REST protocol.

You can reset all HIs on a specific CI, or reset a specific HI.

This REST API is case-sensitive, and uses the PUT method.

Note This API can impact the overall performance of your system; consult with HPE Professional Services before using the API.

ClosedAPI Syntax

  • To reset all HIs related to a CI:

    • https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/cis/<CI ID>/his/reset

  • To reset a specific HI:

    • https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/cis/<CI ID>/his/<HI name>/reset

  • To reset a specific subcomponent of an HI:

    • https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/cis/<CI ID>/his/<HI name>/reset?subcomponent=<subcomponent name>

HI name refers to the name of the HI as defined in the indicator repository, and not to the HI's display label.

ClosedReturn Codes and Log File

The API returns the following return codes:

Name

Error Code

Description

OK

200

Success

UNAUTHORIZED

401

The user is not authorized for the customer

NOT_FOUND

404

  • CI not found

  • HI not found

  • Bad request (syntax error)

INTERNAL_
SERVER_ERROR

500

  • RTSM error

  • Repositories error

  • Online engine error

The service log file is located under: <OMi_HOME_GW>/log/jboss/serviceHealthExternalAPI.log.

In addition, the service writes to the Audit log on each HI reset.

Send Help Center feedback