Cloud Administration Health Check API

You can use the Cloud Administration Health Check API with your application monitoring product to enable you to receive frequent updates on the Cloud Authentication Service availability. This API provides the overall status of the Cloud Authentication Service, available through the status and adjustedStatus parameters. The other parameters are used for internal service checks and can be ignored.

Access the Health Check API

The Health Check API is available through a URL specific to your company.

Procedure

  1. In a browser, go to your health check URL. If you are unsure of the URL, do the following:
    1. In the Cloud Administration Console, click Platform > My Page.
    2. Copy the My Page URL that displays into an editor. The URL looks similar to this:

      https://example.auth-dev.securid.com/mypage

    3. Replace "mypage" with "healthcheck".

      The URL now looks like this:

      https://example.auth-dev.securid.com/healthcheck

  2. Review the status and adjustedStatus parameters and values.

API Parameters

The API returns the following information:

Category Parameter Description
Health check request information received The date and time when the health check request was received.
processed The date and time when the health check request was processed.
hostname The Cloud Authentication Service host that processed the health check request.
Internal parameters shortOffsetSuccess Internal parameters used for health check.
shortOffsetError
longOffsetSuccess
longOffsetError
roundtrip
history

successfulConnectivityChecks

totalConnectivityChecks

successfulResponses

totalResponses

averageRoundtrip

Internal status checks connectivityStatus Internal status checks.
responseSuccessRateStatus
roundtripStatus
Overall status status

Derived from roundtripStatus, responseSuccessRateStatus and connectivityStatus. The lowest value of the three is reported.

  • HEALTHY
  • DEGRADED
  • DOWN
adjustedStatus

The status parameter based on several health checks, with filters for one to two minutes of network glitches.

One of the following values is reported:

  • HEALTHY
  • DEGRADED
  • DOWN

RSA recommends this parameter as the primary way of monitoring the Cloud Authentication Service.