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

     1  # lakefs_client.HealthCheckApi
     2  
     3  All URIs are relative to *http://localhost/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 lakefs_client
    23  from lakefs_client.api import health_check_api
    24  from pprint import pprint
    25  # Defining the host is optional and defaults to http://localhost/api/v1
    26  # See configuration.py for a list of all supported configuration parameters.
    27  configuration = lakefs_client.Configuration(
    28      host = "http://localhost/api/v1"
    29  )
    30  
    31  
    32  # Enter a context with an instance of the API client
    33  with lakefs_client.ApiClient() as api_client:
    34      # Create an instance of the API class
    35      api_instance = health_check_api.HealthCheckApi(api_client)
    36  
    37      # example, this endpoint has no required or optional parameters
    38      try:
    39          api_instance.health_check()
    40      except lakefs_client.ApiException as e:
    41          print("Exception when calling HealthCheckApi->health_check: %s\n" % e)
    42  ```
    43  
    44  
    45  ### Parameters
    46  This endpoint does not need any parameter.
    47  
    48  ### Return type
    49  
    50  void (empty response body)
    51  
    52  ### Authorization
    53  
    54  No authorization required
    55  
    56  ### HTTP request headers
    57  
    58   - **Content-Type**: Not defined
    59   - **Accept**: Not defined
    60  
    61  
    62  ### HTTP response details
    63  
    64  | Status code | Description | Response headers |
    65  |-------------|-------------|------------------|
    66  **204** | NoContent |  -  |
    67  
    68  [[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)
    69