artifact-keeper-client 1.2.1

Rust client for the Artifact Keeper REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

# \MonitoringApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_alert_states**](MonitoringApi.md#get_alert_states) | **GET** /api/v1/admin/monitoring/alerts | GET /api/v1/admin/monitoring/alerts
[**get_health_log**](MonitoringApi.md#get_health_log) | **GET** /api/v1/admin/monitoring/health-log | GET /api/v1/admin/monitoring/health-log
[**run_health_check**](MonitoringApi.md#run_health_check) | **POST** /api/v1/admin/monitoring/check | POST /api/v1/admin/monitoring/check - manually trigger health checks
[**suppress_alert**](MonitoringApi.md#suppress_alert) | **POST** /api/v1/admin/monitoring/alerts/suppress | POST /api/v1/admin/monitoring/alerts/suppress



## get_alert_states

> Vec<models::AlertState> get_alert_states()
GET /api/v1/admin/monitoring/alerts

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

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

### 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 /api/v1/admin/monitoring/health-log

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**service** | Option<**String**> |  |  |
**limit** | Option<**i64**> |  |  |

### Return type

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

### Authorization

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

### 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()
POST /api/v1/admin/monitoring/check - manually trigger health checks

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

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

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

> suppress_alert(suppress_request)
POST /api/v1/admin/monitoring/alerts/suppress

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**suppress_request** | [**SuppressRequest**](SuppressRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

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

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