# \HealthApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**health_check**](HealthApi.md#health_check) | **GET** /health | Health check endpoint -- rich status page for dashboards.
[**liveness_check**](HealthApi.md#liveness_check) | **GET** /livez | Liveness probe - confirms the process is alive and can serve HTTP.
[**metrics**](HealthApi.md#metrics) | **GET** /api/v1/admin/metrics | Prometheus metrics endpoint. Renders all registered metrics from the metrics-exporter-prometheus recorder.
[**readiness_check**](HealthApi.md#readiness_check) | **GET** /readyz | Readiness probe - is the service ready to accept traffic?



## health_check

> models::HealthResponse health_check()
Health check endpoint -- rich status page for dashboards.

Checks database, storage (real write/read probe), optional services (Trivy, OpenSearch), and exposes DB connection pool statistics.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::HealthResponse**](HealthResponse.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)


## liveness_check

> models::LivezResponse liveness_check()
Liveness probe - confirms the process is alive and can serve HTTP.

Takes no State parameter. If Axum can route the request and execute this function, the process is alive. External service failures cannot trigger pod restarts.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::LivezResponse**](LivezResponse.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)


## metrics

> metrics()
Prometheus metrics endpoint. Renders all registered metrics from the metrics-exporter-prometheus recorder.

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

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


## readiness_check

> models::ReadyzResponse readiness_check()
Readiness probe - is the service ready to accept traffic?

Returns 200 once the database is reachable and migrations have applied successfully. Initial-setup state (whether the default admin password has been changed) is reported as an informational field on the response but does NOT influence the status code: a 503 here would make Kubernetes restart the pod, terminating any `kubectl exec` session an operator is using to complete setup. See issue #889.  API mutations are separately gated by the setup middleware (`api::middleware::setup`) until setup is complete, so a 200 from this endpoint does not imply that write traffic will be accepted.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ReadyzResponse**](ReadyzResponse.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)

