Health Check

Check the health status of the NIM Proxy microservice through a GET API call.

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.

---

Options

You can check the health status in the following ways.

API

1. Perform a GET request to the /health endpoint.

   cURL

   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
   

2. Review the response.

   Example Response

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