Status Endpoints

Status Health Check Endpoint

Endpoint: Status Health

Method: GET

RESPONSES:

• 200: Service is up and running

A really simple endpoint that just returns a status OK. Useful for Kubernetes to know if the service has started and it’s running. For more in depth check see the Status Readiness. The endpoint returns the same no matter the Node Configuration.

Status Readiness Check Endpoint

Endpoint: Status Readiness

Method: GET

RESPONSES:

• 200: Service is up and running with a loaded Hyperscan DB
• 400: Service is running but not ready yet. No Hyperscan DB loaded yet

This endpoints acts as a Readiness check for Kubernetes. If the node is of type management then it will always be ready. For management pod the Hyperscan Database doesn’t matter. It is used only for testing. If the Hyperscan Database is loaded then the Node can server requests and therefor it is ready. If the Hyperscan Database is NOT loaded yet then the Node is not ready to server requests.

Status Get Node Configuration Endpoint

Endpoint: Status Get Node Configuration

Method: GET

RESPONSES:

• 200: The configuration as JSON is returned

The Status Get Node Configuration provides the ability to see the configuration of the current Node. After the configuration is loaded (which is one of the first things that the application does) it is in dictionary form and is easily serializable to JSON and returned.