windmill-api 1.683.2

# \CaptureApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_capture**](CaptureApi.md#delete_capture) | **DELETE** /w/{workspace}/capture/{id} | delete a capture
[**get_capture**](CaptureApi.md#get_capture) | **GET** /w/{workspace}/capture/{id} | get a capture
[**get_capture_configs**](CaptureApi.md#get_capture_configs) | **GET** /w/{workspace}/capture/get_configs/{runnable_kind}/{path} | get capture configs for a script or flow
[**list_captures**](CaptureApi.md#list_captures) | **GET** /w/{workspace}/capture/list/{runnable_kind}/{path} | list captures for a script or flow
[**move_captures_and_configs**](CaptureApi.md#move_captures_and_configs) | **POST** /w/{workspace}/capture/move/{runnable_kind}/{path} | move captures and configs for a script or flow
[**ping_capture_config**](CaptureApi.md#ping_capture_config) | **POST** /w/{workspace}/capture/ping_config/{trigger_kind}/{runnable_kind}/{path} | ping capture config
[**set_capture_config**](CaptureApi.md#set_capture_config) | **POST** /w/{workspace}/capture/set_config | set capture config



## delete_capture

> delete_capture(workspace, id)
delete a capture

### Parameters


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

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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_capture

> models::Capture get_capture(workspace, id)
get a capture

### Parameters


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

### Return type

[**models::Capture**](Capture.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_capture_configs

> Vec<models::CaptureConfig> get_capture_configs(workspace, runnable_kind, path)
get capture configs for a script or flow

### Parameters


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

### Return type

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

> Vec<models::Capture> list_captures(workspace, runnable_kind, path, trigger_kind, page, per_page)
list captures for a script or flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**runnable_kind** | **String** |  | [required] |
**path** | **String** |  | [required] |
**trigger_kind** | Option<[**CaptureTriggerKind**](.md)> |  |  |
**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) |  |

### Return type

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


## move_captures_and_configs

> String move_captures_and_configs(workspace, runnable_kind, path, move_captures_and_configs_request)
move captures and configs for a script or flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**runnable_kind** | **String** |  | [required] |
**path** | **String** |  | [required] |
**move_captures_and_configs_request** | [**MoveCapturesAndConfigsRequest**](MoveCapturesAndConfigsRequest.md) | move captures and configs to a new path | [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)


## ping_capture_config

> ping_capture_config(workspace, trigger_kind, runnable_kind, path)
ping capture config

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**trigger_kind** | [**CaptureTriggerKind**](.md) |  | [required] |
**runnable_kind** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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_capture_config

> serde_json::Value set_capture_config(workspace, set_capture_config_request)
set capture config

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**set_capture_config_request** | [**SetCaptureConfigRequest**](SetCaptureConfigRequest.md) | capture config | [required] |

### Return type

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