windmill-api 1.683.1

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

# \WorkerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**exists_workers_with_tags**](WorkerApi.md#exists_workers_with_tags) | **GET** /workers/exists_workers_with_tags | exists workers with tags
[**ge_default_tags**](WorkerApi.md#ge_default_tags) | **GET** /workers/get_default_tags | get all instance default tags
[**get_counts_of_jobs_waiting_per_tag**](WorkerApi.md#get_counts_of_jobs_waiting_per_tag) | **GET** /workers/queue_counts | get counts of jobs waiting for an executor per tag
[**get_counts_of_running_jobs_per_tag**](WorkerApi.md#get_counts_of_running_jobs_per_tag) | **GET** /workers/queue_running_counts | get counts of currently running jobs per tag
[**get_custom_tags**](WorkerApi.md#get_custom_tags) | **GET** /workers/custom_tags | get all instance custom tags (tags are used to dispatch jobs to different worker groups)
[**get_custom_tags_for_workspace**](WorkerApi.md#get_custom_tags_for_workspace) | **GET** /w/{workspace}/workers/custom_tags | get custom tags available for this workspace
[**get_queue_metrics**](WorkerApi.md#get_queue_metrics) | **GET** /workers/queue_metrics | get queue metrics
[**is_default_tags_per_workspace**](WorkerApi.md#is_default_tags_per_workspace) | **GET** /workers/is_default_tags_per_workspace | is default tags per workspace
[**list_workers**](WorkerApi.md#list_workers) | **GET** /workers/list | list workers



## exists_workers_with_tags

> std::collections::HashMap<String, bool> exists_workers_with_tags(tags, workspace)
exists workers with tags

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**tags** | **String** | comma separated list of tags | [required] |
**workspace** | Option<**String**> | workspace to filter tags visibility (required when TAGS_ARE_SENSITIVE is enabled for non-superadmins) |  |

### Return type

**std::collections::HashMap<String, bool>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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)


## ge_default_tags

> Vec<String> ge_default_tags()
get all instance default tags

### Parameters

This endpoint does not need any parameter.

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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_counts_of_jobs_waiting_per_tag

> std::collections::HashMap<String, i32> get_counts_of_jobs_waiting_per_tag()
get counts of jobs waiting for an executor per tag

### Parameters

This endpoint does not need any parameter.

### Return type

**std::collections::HashMap<String, i32>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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_counts_of_running_jobs_per_tag

> std::collections::HashMap<String, i32> get_counts_of_running_jobs_per_tag()
get counts of currently running jobs per tag

### Parameters

This endpoint does not need any parameter.

### Return type

**std::collections::HashMap<String, i32>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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_custom_tags

> Vec<String> get_custom_tags(show_workspace_restriction)
get all instance custom tags (tags are used to dispatch jobs to different worker groups)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**show_workspace_restriction** | Option<**bool**> |  |  |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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_custom_tags_for_workspace

> Vec<String> get_custom_tags_for_workspace(workspace)
get custom tags available for this workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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_queue_metrics

> Vec<models::GetQueueMetrics200ResponseInner> get_queue_metrics()
get queue metrics

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[cookieAuth](../README.md#cookieAuth), [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)


## is_default_tags_per_workspace

> bool is_default_tags_per_workspace()
is default tags per workspace

### Parameters

This endpoint does not need any parameter.

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [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)


## list_workers

> Vec<models::WorkerPing> list_workers(page, per_page, ping_since)
list workers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**ping_since** | Option<**i32**> | number of seconds the worker must have had a last ping more recent of (default to 300) |  |

### Return type

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

### Authorization

[cookieAuth](../README.md#cookieAuth), [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)