# \HealthApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**health**](HealthApi.md#health) | **GET** /health | Checks if Typesense server is ready to accept requests.



## health

> models::HealthStatus health()
Checks if Typesense server is ready to accept requests.

Checks if Typesense server is ready to accept requests.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::HealthStatus**](HealthStatus.md)

### Authorization

[api_key_header](../README.md#api_key_header)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)