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

# \TriggerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_suspended_trigger_jobs**](TriggerApi.md#cancel_suspended_trigger_jobs) | **POST** /w/{workspace}/trigger/{trigger_kind}/cancel_suspended_trigger_jobs/{trigger_path} | cancel all suspended jobs for a specific trigger
[**list_trigger_history**](TriggerApi.md#list_trigger_history) | **GET** /w/{workspace}/triggers_history/list | list the history of schedule and trigger modifications
[**resume_suspended_trigger_jobs**](TriggerApi.md#resume_suspended_trigger_jobs) | **POST** /w/{workspace}/trigger/{trigger_kind}/resume_suspended_trigger_jobs/{trigger_path} | resume all suspended jobs for a specific trigger



## cancel_suspended_trigger_jobs

> String cancel_suspended_trigger_jobs(workspace, trigger_kind, trigger_path, cancel_suspended_trigger_jobs_request)
cancel all suspended jobs for a specific trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**trigger_kind** | [**JobTriggerKind**](.md) | The kind of trigger | [required] |
**trigger_path** | **String** | The path of the trigger (can contain forward slashes) | [required] |
**cancel_suspended_trigger_jobs_request** | Option<[**CancelSuspendedTriggerJobsRequest**](CancelSuspendedTriggerJobsRequest.md)> | Optional list of job IDs to cancel |  |

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


## list_trigger_history

> Vec<models::TriggerHistoryEntry> list_trigger_history(workspace, page, per_page, trigger_kind, path)
list the history of schedule and trigger modifications

### 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) |  |
**trigger_kind** | Option<**String**> | 'schedule' or a trigger type (http, kafka, ...) |  |
**path** | Option<**String**> | only return the history of the trigger at this path |  |

### Return type

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


## resume_suspended_trigger_jobs

> String resume_suspended_trigger_jobs(workspace, trigger_kind, trigger_path, resume_suspended_trigger_jobs_request)
resume all suspended jobs for a specific trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**trigger_kind** | [**JobTriggerKind**](.md) | The kind of trigger | [required] |
**trigger_path** | **String** | The path of the trigger (can contain forward slashes) | [required] |
**resume_suspended_trigger_jobs_request** | Option<[**ResumeSuspendedTriggerJobsRequest**](ResumeSuspendedTriggerJobsRequest.md)> | Optional list of job IDs to reassign |  |

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