windmill-api 1.814.0

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

# \TrashApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**empty_trash**](TrashApi.md#empty_trash) | **POST** /w/{workspace}/trash/empty | permanently delete every item in the workspace trashbin (requires admin privilege)
[**get_trash_item**](TrashApi.md#get_trash_item) | **GET** /w/{workspace}/trash/get/{id} | get a trashed item with the data it was deleted with (requires admin privilege)
[**list_trash**](TrashApi.md#list_trash) | **GET** /w/{workspace}/trash/list | list the workspace trashbin (requires admin privilege)
[**permanently_delete_trash_item**](TrashApi.md#permanently_delete_trash_item) | **DELETE** /w/{workspace}/trash/delete/{id} | permanently delete a trashed item (requires admin privilege)
[**restore_trash_item**](TrashApi.md#restore_trash_item) | **POST** /w/{workspace}/trash/restore/{id} | restore a trashed item to its path (requires admin privilege)



## empty_trash

> String empty_trash(workspace)
permanently delete every item in the workspace trashbin (requires admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **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)


## get_trash_item

> models::TrashItemWithData get_trash_item(workspace, id)
get a trashed item with the data it was deleted with (requires admin privilege)

### Parameters


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

### Return type

[**models::TrashItemWithData**](TrashItemWithData.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_trash

> Vec<models::TrashItem> list_trash(workspace, item_kind, page, per_page)
list the workspace trashbin (requires admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**item_kind** | Option<**String**> | only return items of this kind: script, flow, app, schedule, variable, resource, or a trigger kind such as http_trigger  |  |
**page** | Option<**i32**> | which page to return (starts at 0, default 0) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 100, max 1000) |  |

### Return type

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


## permanently_delete_trash_item

> String permanently_delete_trash_item(workspace, id)
permanently delete a trashed item (requires admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **i32** |  | [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)


## restore_trash_item

> String restore_trash_item(workspace, id)
restore a trashed item to its path (requires admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **i32** |  | [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)