windmill-api 1.680.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
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281

# \SettingApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**acknowledge_all_critical_alerts**](SettingApi.md#acknowledge_all_critical_alerts) | **POST** /settings/critical_alerts/acknowledge_all | Acknowledge all unacknowledged critical alerts
[**acknowledge_critical_alert**](SettingApi.md#acknowledge_critical_alert) | **POST** /settings/critical_alerts/{id}/acknowledge | Acknowledge a critical alert
[**compute_object_storage_usage**](SettingApi.md#compute_object_storage_usage) | **POST** /settings/object_storage_usage | start a background computation of object storage usage by top-level folder
[**create_customer_portal_session**](SettingApi.md#create_customer_portal_session) | **POST** /settings/customer_portal | create customer portal session
[**drop_custom_instance_db**](SettingApi.md#drop_custom_instance_db) | **POST** /settings/drop_custom_instance_pg_database/{name} | Drops a custom instance database (superadmin only, irreversible)
[**get_critical_alerts**](SettingApi.md#get_critical_alerts) | **GET** /settings/critical_alerts | Get all critical alerts
[**get_global**](SettingApi.md#get_global) | **GET** /settings/global/{key} | get global settings
[**get_instance_config**](SettingApi.md#get_instance_config) | **GET** /settings/instance_config | get full instance config (global settings + worker configs)
[**get_jwks**](SettingApi.md#get_jwks) | **GET** /.well-known/jwks.json | get JWKS for Vault JWT authentication
[**get_latest_key_renewal_attempt**](SettingApi.md#get_latest_key_renewal_attempt) | **GET** /settings/latest_key_renewal_attempt | get latest key renewal attempt
[**get_local**](SettingApi.md#get_local) | **GET** /settings/local | get local settings
[**get_log_cleanup_status**](SettingApi.md#get_log_cleanup_status) | **GET** /settings/log_cleanup_status | get status of the manual log cleanup task
[**get_min_keep_alive_version**](SettingApi.md#get_min_keep_alive_version) | **GET** /min_keep_alive_version | get minimum worker versions required to stay alive
[**get_object_storage_usage**](SettingApi.md#get_object_storage_usage) | **GET** /settings/object_storage_usage | get current or last object storage usage computation (null if never run)
[**get_secondary_storage_names**](SettingApi.md#get_secondary_storage_names) | **GET** /w/{workspace}/workspaces/get_secondary_storage_names | get secondary storage names
[**get_stats**](SettingApi.md#get_stats) | **GET** /settings/get_stats | get telemetry stats with HMAC signature (EE only)
[**list_custom_instance_dbs**](SettingApi.md#list_custom_instance_dbs) | **POST** /settings/list_custom_instance_pg_databases | Returns the set-up statuses of custom instance pg databases
[**list_global_settings**](SettingApi.md#list_global_settings) | **GET** /settings/list_global | list global settings
[**migrate_secrets_from_aws_sm**](SettingApi.md#migrate_secrets_from_aws_sm) | **POST** /settings/migrate_secrets_from_aws_sm | migrate secrets from AWS Secrets Manager to database
[**migrate_secrets_from_azure_kv**](SettingApi.md#migrate_secrets_from_azure_kv) | **POST** /settings/migrate_secrets_from_azure_kv | migrate secrets from Azure Key Vault to database
[**migrate_secrets_to_aws_sm**](SettingApi.md#migrate_secrets_to_aws_sm) | **POST** /settings/migrate_secrets_to_aws_sm | migrate secrets from database to AWS Secrets Manager
[**migrate_secrets_to_azure_kv**](SettingApi.md#migrate_secrets_to_azure_kv) | **POST** /settings/migrate_secrets_to_azure_kv | migrate secrets from database to Azure Key Vault
[**migrate_secrets_to_database**](SettingApi.md#migrate_secrets_to_database) | **POST** /settings/migrate_secrets_to_database | migrate secrets from HashiCorp Vault to database
[**migrate_secrets_to_vault**](SettingApi.md#migrate_secrets_to_vault) | **POST** /settings/migrate_secrets_to_vault | migrate secrets from database to HashiCorp Vault
[**refresh_custom_instance_user_pwd**](SettingApi.md#refresh_custom_instance_user_pwd) | **POST** /settings/refresh_custom_instance_user_pwd | Refreshes the password for the custom_instance_user
[**renew_license_key**](SettingApi.md#renew_license_key) | **POST** /settings/renew_license_key | renew license key
[**restart_worker_group**](SettingApi.md#restart_worker_group) | **POST** /settings/restart_worker_group/{worker_group} | restart worker group
[**run_log_cleanup**](SettingApi.md#run_log_cleanup) | **POST** /settings/run_log_cleanup | start a manual cleanup of expired logs from object storage
[**send_stats**](SettingApi.md#send_stats) | **POST** /settings/send_stats | send stats
[**set_global**](SettingApi.md#set_global) | **POST** /settings/global/{key} | post global settings
[**set_instance_config**](SettingApi.md#set_instance_config) | **PUT** /settings/instance_config | update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
[**set_public_app_rate_limit**](SettingApi.md#set_public_app_rate_limit) | **POST** /w/{workspace}/workspaces/public_app_rate_limit | Set public app rate limit for this workspace
[**setup_custom_instance_db**](SettingApi.md#setup_custom_instance_db) | **POST** /settings/setup_custom_instance_pg_database/{name} | Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user
[**test_aws_sm_backend**](SettingApi.md#test_aws_sm_backend) | **POST** /settings/test_aws_sm_backend | test connection to AWS Secrets Manager
[**test_azure_kv_backend**](SettingApi.md#test_azure_kv_backend) | **POST** /settings/test_azure_kv_backend | test Azure Key Vault connection
[**test_critical_channels**](SettingApi.md#test_critical_channels) | **POST** /settings/test_critical_channels | test critical channels
[**test_license_key**](SettingApi.md#test_license_key) | **POST** /settings/test_license_key | test license key
[**test_metadata**](SettingApi.md#test_metadata) | **POST** /saml/test_metadata | test metadata
[**test_object_storage_config**](SettingApi.md#test_object_storage_config) | **POST** /settings/test_object_storage_config | test object storage config
[**test_secret_backend**](SettingApi.md#test_secret_backend) | **POST** /settings/test_secret_backend | test secret backend connection (HashiCorp Vault)
[**test_smtp**](SettingApi.md#test_smtp) | **POST** /settings/test_smtp | test smtp
[**workspace_acknowledge_all_critical_alerts**](SettingApi.md#workspace_acknowledge_all_critical_alerts) | **POST** /w/{workspace}/workspaces/critical_alerts/acknowledge_all | Acknowledge all unacknowledged critical alerts for this workspace
[**workspace_acknowledge_critical_alert**](SettingApi.md#workspace_acknowledge_critical_alert) | **POST** /w/{workspace}/workspaces/critical_alerts/{id}/acknowledge | Acknowledge a critical alert for this workspace
[**workspace_get_critical_alerts**](SettingApi.md#workspace_get_critical_alerts) | **GET** /w/{workspace}/workspaces/critical_alerts | Get all critical alerts for this workspace
[**workspace_mute_critical_alerts_ui**](SettingApi.md#workspace_mute_critical_alerts_ui) | **POST** /w/{workspace}/workspaces/critical_alerts/mute | Mute critical alert UI for this workspace



## acknowledge_all_critical_alerts

> String acknowledge_all_critical_alerts()
Acknowledge all unacknowledged critical alerts

### Parameters

This endpoint does not need any parameter.

### Return type

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


## acknowledge_critical_alert

> String acknowledge_critical_alert(id)
Acknowledge a critical alert

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the critical alert to acknowledge | [required] |

### Return type

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


## compute_object_storage_usage

> String compute_object_storage_usage()
start a background computation of object storage usage by top-level folder

### Parameters

This endpoint does not need any parameter.

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


## create_customer_portal_session

> String create_customer_portal_session(license_key)
create customer portal session

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**license_key** | Option<**String**> |  |  |

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


## drop_custom_instance_db

> String drop_custom_instance_db(name)
Drops a custom instance database (superadmin only, irreversible)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the database to drop | [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_critical_alerts

> models::GetCriticalAlerts200Response get_critical_alerts(page, page_size, acknowledged)
Get all critical alerts

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> |  |  |[default to 1]
**page_size** | Option<**i32**> |  |  |[default to 10]
**acknowledged** | Option<**bool**> |  |  |

### Return type

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


## get_global

> serde_json::Value get_global(key)
get global settings

### Parameters


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

### Return type

[**serde_json::Value**](serde_json::Value.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)


## get_instance_config

> models::InstanceConfig get_instance_config()
get full instance config (global settings + worker configs)

### Parameters

This endpoint does not need any parameter.

### Return type

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


## get_jwks

> models::JwksResponse get_jwks()
get JWKS for Vault JWT authentication

### Parameters

This endpoint does not need any parameter.

### Return type

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


## get_latest_key_renewal_attempt

> models::GetLatestKeyRenewalAttempt200Response get_latest_key_renewal_attempt()
get latest key renewal attempt

### Parameters

This endpoint does not need any parameter.

### Return type

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


## get_local

> serde_json::Value get_local()
get local settings

### Parameters

This endpoint does not need any parameter.

### Return type

[**serde_json::Value**](serde_json::Value.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)


## get_log_cleanup_status

> models::GetLogCleanupStatus200Response get_log_cleanup_status()
get status of the manual log cleanup task

### Parameters

This endpoint does not need any parameter.

### Return type

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


## get_min_keep_alive_version

> models::GetMinKeepAliveVersion200Response get_min_keep_alive_version()
get minimum worker versions required to stay alive

### Parameters

This endpoint does not need any parameter.

### Return type

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


## get_object_storage_usage

> models::GetObjectStorageUsage200Response get_object_storage_usage()
get current or last object storage usage computation (null if never run)

### Parameters

This endpoint does not need any parameter.

### Return type

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


## get_secondary_storage_names

> Vec<String> get_secondary_storage_names(workspace, include_default)
get secondary storage names

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**include_default** | Option<**bool**> | If true, include \"_default_\" in the list if primary workspace storage is set |  |[default to false]

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

> models::GetStats200Response get_stats()
get telemetry stats with HMAC signature (EE only)

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetStats200Response**](getStats_200_response.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_custom_instance_dbs

> std::collections::HashMap<String, models::CustomInstanceDb> list_custom_instance_dbs()
Returns the set-up statuses of custom instance pg databases

### Parameters

This endpoint does not need any parameter.

### Return type

[**std::collections::HashMap<String, models::CustomInstanceDb>**](CustomInstanceDb.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_global_settings

> Vec<models::GlobalSetting> list_global_settings()
list global settings

### Parameters

This endpoint does not need any parameter.

### Return type

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


## migrate_secrets_from_aws_sm

> models::SecretMigrationReport migrate_secrets_from_aws_sm(aws_secrets_manager_settings)
migrate secrets from AWS Secrets Manager to database

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**aws_secrets_manager_settings** | [**AwsSecretsManagerSettings**](AwsSecretsManagerSettings.md) |  | [required] |

### Return type

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

### Authorization

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


## migrate_secrets_from_azure_kv

> models::SecretMigrationReport migrate_secrets_from_azure_kv(azure_key_vault_settings)
migrate secrets from Azure Key Vault to database

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**azure_key_vault_settings** | [**AzureKeyVaultSettings**](AzureKeyVaultSettings.md) | Azure Key Vault settings for migration source | [required] |

### Return type

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

### Authorization

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


## migrate_secrets_to_aws_sm

> models::SecretMigrationReport migrate_secrets_to_aws_sm(aws_secrets_manager_settings)
migrate secrets from database to AWS Secrets Manager

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**aws_secrets_manager_settings** | [**AwsSecretsManagerSettings**](AwsSecretsManagerSettings.md) |  | [required] |

### Return type

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

### Authorization

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


## migrate_secrets_to_azure_kv

> models::SecretMigrationReport migrate_secrets_to_azure_kv(azure_key_vault_settings)
migrate secrets from database to Azure Key Vault

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**azure_key_vault_settings** | [**AzureKeyVaultSettings**](AzureKeyVaultSettings.md) | Azure Key Vault settings for migration target | [required] |

### Return type

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

### Authorization

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


## migrate_secrets_to_database

> models::SecretMigrationReport migrate_secrets_to_database(vault_settings)
migrate secrets from HashiCorp Vault to database

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vault_settings** | [**VaultSettings**](VaultSettings.md) | Vault settings for migration source | [required] |

### Return type

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

### Authorization

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


## migrate_secrets_to_vault

> models::SecretMigrationReport migrate_secrets_to_vault(vault_settings)
migrate secrets from database to HashiCorp Vault

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vault_settings** | [**VaultSettings**](VaultSettings.md) | Vault settings for migration target | [required] |

### Return type

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

### Authorization

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


## refresh_custom_instance_user_pwd

> serde_json::Value refresh_custom_instance_user_pwd()
Refreshes the password for the custom_instance_user

### Parameters

This endpoint does not need any parameter.

### Return type

[**serde_json::Value**](serde_json::Value.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)


## renew_license_key

> String renew_license_key(license_key)
renew license key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**license_key** | Option<**String**> |  |  |

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


## restart_worker_group

> String restart_worker_group(worker_group)
restart worker group

Send a restart signal to all workers in the specified worker group. Workers will gracefully shut down and are expected to be restarted by their supervisor. Requires devops role.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**worker_group** | **String** | the name of the worker group to restart | [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)


## run_log_cleanup

> String run_log_cleanup()
start a manual cleanup of expired logs from object storage

### Parameters

This endpoint does not need any parameter.

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


## send_stats

> String send_stats()
send stats

### Parameters

This endpoint does not need any parameter.

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


## set_global

> String set_global(key, set_global_request)
post global settings

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | **String** |  | [required] |
**set_global_request** | [**SetGlobalRequest**](SetGlobalRequest.md) | value set | [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)


## set_instance_config

> String set_instance_config(instance_config)
update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**instance_config** | [**InstanceConfig**](InstanceConfig.md) | full instance configuration to apply | [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)


## set_public_app_rate_limit

> String set_public_app_rate_limit(workspace, set_public_app_rate_limit_request)
Set public app rate limit for this workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**set_public_app_rate_limit_request** | [**SetPublicAppRateLimitRequest**](SetPublicAppRateLimitRequest.md) | Public app rate limit configuration | [required] |

### Return type

**String**

### Authorization

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


## setup_custom_instance_db

> models::CustomInstanceDb setup_custom_instance_db(name, setup_custom_instance_db_request)
Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** | The name of the database to create | [required] |
**setup_custom_instance_db_request** | [**SetupCustomInstanceDbRequest**](SetupCustomInstanceDbRequest.md) |  | [required] |

### Return type

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

### Authorization

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


## test_aws_sm_backend

> String test_aws_sm_backend(aws_secrets_manager_settings)
test connection to AWS Secrets Manager

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**aws_secrets_manager_settings** | [**AwsSecretsManagerSettings**](AwsSecretsManagerSettings.md) |  | [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_azure_kv_backend

> String test_azure_kv_backend(azure_key_vault_settings)
test Azure Key Vault connection

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**azure_key_vault_settings** | [**AzureKeyVaultSettings**](AzureKeyVaultSettings.md) | Azure Key Vault settings to test | [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_critical_channels

> String test_critical_channels(test_critical_channels_request_inner)
test critical channels

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**test_critical_channels_request_inner** | [**Vec<models::TestCriticalChannelsRequestInner>**](testCriticalChannels_request_inner.md) | test critical channel payload | [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_license_key

> String test_license_key(test_license_key_request)
test license key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**test_license_key_request** | [**TestLicenseKeyRequest**](TestLicenseKeyRequest.md) | test license key | [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_metadata

> String test_metadata(body)
test metadata

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **String** | test metadata | [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_object_storage_config

> String test_object_storage_config(request_body)
test object storage config

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_body** | [**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md) | test object storage config | [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_secret_backend

> String test_secret_backend(vault_settings)
test secret backend connection (HashiCorp Vault)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vault_settings** | [**VaultSettings**](VaultSettings.md) | Vault settings to test | [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_smtp

> String test_smtp(test_smtp_request)
test smtp

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**test_smtp_request** | [**TestSmtpRequest**](TestSmtpRequest.md) | test smtp payload | [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)


## workspace_acknowledge_all_critical_alerts

> String workspace_acknowledge_all_critical_alerts(workspace)
Acknowledge all unacknowledged critical alerts for this workspace

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


## workspace_acknowledge_critical_alert

> String workspace_acknowledge_critical_alert(workspace, id)
Acknowledge a critical alert for this workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **i32** | The ID of the critical alert to acknowledge | [required] |

### Return type

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


## workspace_get_critical_alerts

> models::GetCriticalAlerts200Response workspace_get_critical_alerts(workspace, page, page_size, acknowledged)
Get all critical alerts for this workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> |  |  |[default to 1]
**page_size** | Option<**i32**> |  |  |[default to 10]
**acknowledged** | Option<**bool**> |  |  |

### Return type

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


## workspace_mute_critical_alerts_ui

> String workspace_mute_critical_alerts_ui(workspace, workspace_mute_critical_alerts_ui_request)
Mute critical alert UI for this workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**workspace_mute_critical_alerts_ui_request** | [**WorkspaceMuteCriticalAlertsUiRequest**](WorkspaceMuteCriticalAlertsUiRequest.md) | Boolean flag to mute critical alerts. | [required] |

### Return type

**String**

### Authorization

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