github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java/docs/HealthCheckApi.md (about)

     1  # HealthCheckApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  | Method | HTTP request | Description |
     6  |------------- | ------------- | -------------|
     7  | [**healthCheck**](HealthCheckApi.md#healthCheck) | **GET** /healthcheck |  |
     8  
     9  
    10  <a id="healthCheck"></a>
    11  # **healthCheck**
    12  > healthCheck().execute();
    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.sdk.ApiClient;
    22  import io.lakefs.clients.sdk.ApiException;
    23  import io.lakefs.clients.sdk.Configuration;
    24  import io.lakefs.clients.sdk.models.*;
    25  import io.lakefs.clients.sdk.HealthCheckApi;
    26  
    27  public class Example {
    28    public static void main(String[] args) {
    29      ApiClient defaultClient = Configuration.getDefaultApiClient();
    30      defaultClient.setBasePath("/api/v1");
    31  
    32      HealthCheckApi apiInstance = new HealthCheckApi(defaultClient);
    33      try {
    34        apiInstance.healthCheck()
    35              .execute();
    36      } catch (ApiException e) {
    37        System.err.println("Exception when calling HealthCheckApi#healthCheck");
    38        System.err.println("Status code: " + e.getCode());
    39        System.err.println("Reason: " + e.getResponseBody());
    40        System.err.println("Response headers: " + e.getResponseHeaders());
    41        e.printStackTrace();
    42      }
    43    }
    44  }
    45  ```
    46  
    47  ### Parameters
    48  This endpoint does not need any parameter.
    49  
    50  ### Return type
    51  
    52  null (empty response body)
    53  
    54  ### Authorization
    55  
    56  No authorization required
    57  
    58  ### HTTP request headers
    59  
    60   - **Content-Type**: Not defined
    61   - **Accept**: Not defined
    62  
    63  ### HTTP response details
    64  | Status code | Description | Response headers |
    65  |-------------|-------------|------------------|
    66  | **204** | NoContent |  -  |
    67