# \HealthApi

All URIs are relative to *https://registry.example.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_health**](HealthApi.md#get_health) | **GET** /health | Health check
[**get_metrics**](HealthApi.md#get_metrics) | **GET** /metrics | Prometheus metrics
[**get_readiness**](HealthApi.md#get_readiness) | **GET** /ready | Readiness probe



## get_health

> models::GetHealth200Response get_health()
Health check

Returns the health status of the service and its dependencies including database, storage, and scanner subsystems.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetHealth200Response**](getHealth_200_response.md)

### Authorization

No authorization required

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


## get_metrics

> String get_metrics()
Prometheus metrics

Returns Prometheus-formatted metrics for monitoring and alerting.

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, 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)


## get_readiness

> models::GetReadiness200Response get_readiness()
Readiness probe

Returns whether the service is ready to accept traffic. Intended for use by container orchestrators and load balancers.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetReadiness200Response**](getReadiness_200_response.md)

### Authorization

No authorization required

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

