# \MonitoringApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_alert_states**](MonitoringApi.md#get_alert_states) | **GET** /api/v1/admin/monitoring/alerts | Get alert states
[**get_health_log**](MonitoringApi.md#get_health_log) | **GET** /api/v1/admin/monitoring/health-log | Get health check log
[**run_health_check**](MonitoringApi.md#run_health_check) | **POST** /api/v1/admin/monitoring/check | Run immediate health check
[**suppress_alert**](MonitoringApi.md#suppress_alert) | **POST** /api/v1/admin/monitoring/alerts/suppress | Suppress alerts for a service



## get_alert_states

> Vec<models::AlertState> get_alert_states()
Get alert states

Returns the current alert state for every monitored service, including consecutive failure counts, last alert timestamp, and suppression windows.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::AlertState>**](AlertState.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

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

> Vec<models::ServiceHealthEntry> get_health_log(service, limit)
Get health check log

Returns recent health check entries, optionally filtered by service name. Each entry captures the result of a periodic health probe including status, response time, and any error messages.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**service** | Option<**String**> | Filter entries to a specific service name (e.g. \"database\", \"storage\", \"meilisearch\"). |  |
**limit** | Option<**i32**> | Maximum number of entries to return. Defaults to 100. |  |

### Return type

[**Vec<models::ServiceHealthEntry>**](ServiceHealthEntry.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

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


## run_health_check

> Vec<models::ServiceHealthEntry> run_health_check()
Run immediate health check

Triggers an immediate health check against all monitored services and returns the results. This bypasses the normal polling interval and records the results in the health log.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ServiceHealthEntry>**](ServiceHealthEntry.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

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


## suppress_alert

> models::AlertState suppress_alert(suppress_alert_request)
Suppress alerts for a service

Suppresses alert notifications for the specified service until the given timestamp. Existing alerts are not cleared, but no new notifications will be sent until the suppression window expires.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**suppress_alert_request** | [**SuppressAlertRequest**](SuppressAlertRequest.md) |  | [required] |

### Return type

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

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)

