Testing the API service Govern

The Custom API supports the use of a "health check" resource allowing you to test a newly configured API service. This check does not perform any authentication or authorization, but performs a self-check to ensure that the service has a valid configuration and can access all necessary systems, such as databases.

You can execute the check by sending an API request using the following syntax:

https://<hostname>/services/custom/<service_name>/<endpoint_name>/<version>/ health

This request returns no data. For a successful test, the request returns a 2XX response code. If the test fails, a 5XX response code is returned.