Health Check#

This document describes how to check the health of the NIM Proxy service.

Prerequisites#

Before you can check the health status, make sure that you have:

  • Access to the NIM Proxy microservice through the base URL where the service is deployed. Store the base URL in an environment variable NIM_PROXY_BASE_URL.

To Check the Health Status#

Choose one of the following options of checking the health status.

Use one of the following cURL commands. For more details on the request body, see the NIM Proxy API reference.

curl -X GET \
   "${NIM_PROXY_BASE_URL}/health" \
   -H 'accept: application/json' | jq

Review the response.

Example Response
{
   "status": "healthy",
   "timestamp": "2024-01-01T00:00:00Z"
}