windmill-api 1.684.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

# \WebsocketTriggerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_websocket_trigger**](WebsocketTriggerApi.md#create_websocket_trigger) | **POST** /w/{workspace}/websocket_triggers/create | create websocket trigger
[**delete_websocket_trigger**](WebsocketTriggerApi.md#delete_websocket_trigger) | **DELETE** /w/{workspace}/websocket_triggers/delete/{path} | delete websocket trigger
[**exists_websocket_trigger**](WebsocketTriggerApi.md#exists_websocket_trigger) | **GET** /w/{workspace}/websocket_triggers/exists/{path} | does websocket trigger exists
[**get_websocket_trigger**](WebsocketTriggerApi.md#get_websocket_trigger) | **GET** /w/{workspace}/websocket_triggers/get/{path} | get websocket trigger
[**list_websocket_triggers**](WebsocketTriggerApi.md#list_websocket_triggers) | **GET** /w/{workspace}/websocket_triggers/list | list websocket triggers
[**set_websocket_trigger_mode**](WebsocketTriggerApi.md#set_websocket_trigger_mode) | **POST** /w/{workspace}/websocket_triggers/setmode/{path} | set enabled websocket trigger
[**test_websocket_connection**](WebsocketTriggerApi.md#test_websocket_connection) | **POST** /w/{workspace}/websocket_triggers/test | test websocket connection
[**update_websocket_trigger**](WebsocketTriggerApi.md#update_websocket_trigger) | **POST** /w/{workspace}/websocket_triggers/update/{path} | update websocket trigger



## create_websocket_trigger

> String create_websocket_trigger(workspace, new_websocket_trigger)
create websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_websocket_trigger** | [**NewWebsocketTrigger**](NewWebsocketTrigger.md) | new websocket trigger | [required] |

### Return type

**String**

### Authorization

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

### HTTP request headers

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


## delete_websocket_trigger

> String delete_websocket_trigger(workspace, path)
delete websocket trigger

### Parameters


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

### Return type

**String**

### Authorization

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

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


## exists_websocket_trigger

> bool exists_websocket_trigger(workspace, path)
does websocket trigger exists

### Parameters


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

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


## get_websocket_trigger

> models::WebsocketTrigger get_websocket_trigger(workspace, path)
get websocket trigger

### Parameters


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

### Return type

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


## list_websocket_triggers

> Vec<models::WebsocketTrigger> list_websocket_triggers(workspace, page, per_page, path, is_flow, path_start, label)
list websocket triggers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**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) |  |
**path** | Option<**String**> | filter by path |  |
**is_flow** | Option<**bool**> |  |  |
**path_start** | Option<**String**> |  |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

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


## set_websocket_trigger_mode

> String set_websocket_trigger_mode(workspace, path, set_http_trigger_mode_request)
set enabled websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**set_http_trigger_mode_request** | [**SetHttpTriggerModeRequest**](SetHttpTriggerModeRequest.md) | updated websocket trigger enable | [required] |

### Return type

**String**

### Authorization

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

### HTTP request headers

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


## test_websocket_connection

> String test_websocket_connection(workspace, test_websocket_connection_request)
test websocket connection

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**test_websocket_connection_request** | [**TestWebsocketConnectionRequest**](TestWebsocketConnectionRequest.md) | test websocket connection | [required] |

### Return type

**String**

### Authorization

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

### HTTP request headers

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


## update_websocket_trigger

> String update_websocket_trigger(workspace, path, edit_websocket_trigger)
update websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**edit_websocket_trigger** | [**EditWebsocketTrigger**](EditWebsocketTrigger.md) | updated trigger | [required] |

### Return type

**String**

### Authorization

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

### HTTP request headers

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