github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/apiguard/tykgen/docs/HealthCheckingApi.md (about)

     1  # {{classname}}
     2  
     3  All URIs are relative to *http://localhost/*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**Hello**](HealthCheckingApi.md#Hello) | **Get** /tyk/hello | Check the Health of the Tyk Gateway
     8  
     9  # **Hello**
    10  > string Hello(ctx, )
    11  Check the Health of the Tyk Gateway
    12  
    13  From v2.7.5 you can now rename the `/hello`  endpoint by using the `health_check_endpoint_name` option  Returns 200 response in case of success 
    14  
    15  ### Required Parameters
    16  This endpoint does not need any parameter.
    17  
    18  ### Return type
    19  
    20  **string**
    21  
    22  ### Authorization
    23  
    24  [api_key](../README.md#api_key)
    25  
    26  ### HTTP request headers
    27  
    28   - **Content-Type**: Not defined
    29   - **Accept**: text/html
    30  
    31  [[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)
    32