github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java-legacy/docs/HealthCheckApi.md (about) 1 # HealthCheckApi 2 3 All URIs are relative to *http://localhost/api/v1* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**healthCheck**](HealthCheckApi.md#healthCheck) | **GET** /healthcheck | 8 9 10 <a name="healthCheck"></a> 11 # **healthCheck** 12 > healthCheck() 13 14 15 16 check that the API server is up and running 17 18 ### Example 19 ```java 20 // Import classes: 21 import io.lakefs.clients.api.ApiClient; 22 import io.lakefs.clients.api.ApiException; 23 import io.lakefs.clients.api.Configuration; 24 import io.lakefs.clients.api.models.*; 25 import io.lakefs.clients.api.HealthCheckApi; 26 27 public class Example { 28 public static void main(String[] args) { 29 ApiClient defaultClient = Configuration.getDefaultApiClient(); 30 defaultClient.setBasePath("http://localhost/api/v1"); 31 32 HealthCheckApi apiInstance = new HealthCheckApi(defaultClient); 33 try { 34 apiInstance.healthCheck(); 35 } catch (ApiException e) { 36 System.err.println("Exception when calling HealthCheckApi#healthCheck"); 37 System.err.println("Status code: " + e.getCode()); 38 System.err.println("Reason: " + e.getResponseBody()); 39 System.err.println("Response headers: " + e.getResponseHeaders()); 40 e.printStackTrace(); 41 } 42 } 43 } 44 ``` 45 46 ### Parameters 47 This endpoint does not need any parameter. 48 49 ### Return type 50 51 null (empty response body) 52 53 ### Authorization 54 55 No authorization required 56 57 ### HTTP request headers 58 59 - **Content-Type**: Not defined 60 - **Accept**: Not defined 61 62 ### HTTP response details 63 | Status code | Description | Response headers | 64 |-------------|-------------|------------------| 65 **204** | NoContent | - | 66