General Information About System Health Checks
The system provides an API method for the Portal Web Server, which can be used to (1) check the active status and normal response from all solution components, and (2) confirm that authentication mechanism still works. (The latter can sometimes be overlooked during regular HTTP ping checks). This API method can be used for periodic system health checks and timely alerts to the operations personnel.
The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The provided username is checked against the list of users configured at the service provider level. The session is established provided that the supplied credentials are authenticated and that the user’s role indicate his or her authorization to perform health checks (i.e., the user must have a role with the Check health of the system using API privilege enabled in the Bright Pattern Service Provider application).
Standard HTTP response codes whose meaning conforms to the original specification (RFC 2616) are not discussed in this document. For specification of such responses, see section 10 of http://www.ietf.org/rfc/rfc2616.txt. Only the response codes whose description deviates from the original specification (e.g., is defined more narrowly or has a different meaning) are specified below.