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 Access Service (CAS) availability. This API provides the overall status of CAS, available through the status and adjustedStatus parameters. The other parameters are used for internal service checks and can be ignored.
For information about managing access to this API, see Accessing the Cloud Administration APIs.
Access the Health Check API
The Health Check API is available through a URL specific to your company.
Procedure
- In a browser, go to your health check URL. If you are unsure of the URL, do the following:
- In the Cloud Administration Console, click Platform > My Page.
Copy the My Page URL that displays into an editor. The URL looks similar to this:
Replace "mypage" with "healthcheck".
The URL now looks like this:
https://example.auth-dev.securid.com/AdminInterface/healthcheck
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 CAS 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.
|
| 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:
RSA recommends this parameter as the primary way of monitoring CAS. |
Related Articles
RSA Governance & Lifecycle Recipes: System Health Check Dashboard Number of Views Cloudflare - SAML My Page SSO Configuration - RSA Ready Implementation Guide Number of Views URL for RCM health check when configuring load balancers Number of Views How to set health check servlet on Number of Views SCIM API for User Search Number of Views
Trending Articles
Download RSA SecurID Access Cloud User Event audit logs using Cloud Administration REST API CLU RSA MFA Agent 2.5 for Microsoft Windows Installation and Administration Guide Quick Setup Guide - Passwordless Authentication in Windows MFA Agent for Active Directory Authentication Manager Security Console and Operations Console Inaccessible After Certificate Update Authentication Manager How to Retrieve the LDAPS Certificate and Configure an External Identity Source to Use LDAPS
