|
| 1 | +# permify.HealthApi |
| 2 | + |
| 3 | +All URIs are relative to *http://localhost* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**health_check**](HealthApi.md#health_check) | **GET** /healthz | health api |
| 8 | + |
| 9 | + |
| 10 | +# **health_check** |
| 11 | +> HealthResponse health_check() |
| 12 | +
|
| 13 | +health api |
| 14 | + |
| 15 | +### Example |
| 16 | + |
| 17 | + |
| 18 | +```python |
| 19 | +import permify |
| 20 | +from permify.models.health_response import HealthResponse |
| 21 | +from permify.rest import ApiException |
| 22 | +from pprint import pprint |
| 23 | + |
| 24 | +# Defining the host is optional and defaults to http://localhost |
| 25 | +# See configuration.py for a list of all supported configuration parameters. |
| 26 | +configuration = permify.Configuration( |
| 27 | + host = "http://localhost" |
| 28 | +) |
| 29 | + |
| 30 | + |
| 31 | +# Enter a context with an instance of the API client |
| 32 | +with permify.ApiClient(configuration) as api_client: |
| 33 | + # Create an instance of the API class |
| 34 | + api_instance = permify.HealthApi(api_client) |
| 35 | + |
| 36 | + try: |
| 37 | + # health api |
| 38 | + api_response = api_instance.health_check() |
| 39 | + print("The response of HealthApi->health_check:\n") |
| 40 | + pprint(api_response) |
| 41 | + except Exception as e: |
| 42 | + print("Exception when calling HealthApi->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 | +[**HealthResponse**](HealthResponse.md) |
| 54 | + |
| 55 | +### Authorization |
| 56 | + |
| 57 | +No authorization required |
| 58 | + |
| 59 | +### HTTP request headers |
| 60 | + |
| 61 | + - **Content-Type**: Not defined |
| 62 | + - **Accept**: application/json |
| 63 | + |
| 64 | +### HTTP response details |
| 65 | + |
| 66 | +| Status code | Description | Response headers | |
| 67 | +|-------------|-------------|------------------| |
| 68 | +**200** | A successful response. | - | |
| 69 | +**0** | An unexpected error response. | - | |
| 70 | + |
| 71 | +[[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) |
| 72 | + |
0 commit comments