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

     1  # lakefs_sdk.HealthCheckApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**health_check**](HealthCheckApi.md#health_check) | **GET** /healthcheck | 
     8  
     9  
    10  # **health_check**
    11  > health_check()
    12  
    13  
    14  
    15  check that the API server is up and running
    16  
    17  ### Example
    18  
    19  
    20  ```python
    21  import time
    22  import os
    23  import lakefs_sdk
    24  from lakefs_sdk.rest import ApiException
    25  from pprint import pprint
    26  
    27  # Defining the host is optional and defaults to /api/v1
    28  # See configuration.py for a list of all supported configuration parameters.
    29  configuration = lakefs_sdk.Configuration(
    30      host = "/api/v1"
    31  )
    32  
    33  
    34  # Enter a context with an instance of the API client
    35  with lakefs_sdk.ApiClient(configuration) as api_client:
    36      # Create an instance of the API class
    37      api_instance = lakefs_sdk.HealthCheckApi(api_client)
    38  
    39      try:
    40          api_instance.health_check()
    41      except Exception as e:
    42          print("Exception when calling HealthCheckApi->health_check: %s\n" % e)
    43  ```
    44  
    45  
    46  
    47  ### Parameters
    48  
    49  This endpoint does not need any parameter.
    50  
    51  ### Return type
    52  
    53  void (empty response body)
    54  
    55  ### Authorization
    56  
    57  No authorization required
    58  
    59  ### HTTP request headers
    60  
    61   - **Content-Type**: Not defined
    62   - **Accept**: Not defined
    63  
    64  ### HTTP response details
    65  
    66  | Status code | Description | Response headers |
    67  |-------------|-------------|------------------|
    68  **204** | NoContent |  -  |
    69  
    70  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    71