Health check

Prev Next

You can use some health check APIs to monitor the services/daemons and verify if they are available and working properly.

OneSpan Authentication Server

The OneSpan Authentication Server health check endpoint is enabled by default using port 8889 and /health as URL extension.

http://oas_host:8889/health

  • oas_host. The host that runs the OneSpan Authentication Server service/daemon (IP address, host name, or FQDN).

If you send an HTTP GET request to this endpoint, one of the following HTTP status codes is returned in a log file, according to the service status:

  • HTTP 200. Health check request successful.

  • HTTP 404. Unsupported URL.

  • HTTP 503. Health check request failed.

Web Administration Service

If you deploy the Administration Web Interface via the provided setup package, the embedded Apache Tomcat web application server is pre-configured to provide a health check endpoint.

https://was_host:was_port/health

  • was_host. The host that runs the Web Administration Service (IP address, host name, or FQDN).

  • was_port. The port of the Web Administration Service.

If you send an HTTP GET request to this endpoint, you will receive an HTTP status code and, in case of 200, a JSON status structure. This endpoint can also be used to respond to cloud orchestrator health checks.

If you deploy the Administration Web Interface manually, you need to configure the web application server accordingly to provide a health check if possible.