# \KafkaTriggerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**commit_kafka_offsets**](KafkaTriggerApi.md#commit_kafka_offsets) | **POST** /w/{workspace}/kafka_triggers/commit_offsets/{path} | commit kafka offsets for a specific trigger
[**create_kafka_trigger**](KafkaTriggerApi.md#create_kafka_trigger) | **POST** /w/{workspace}/kafka_triggers/create | create kafka trigger
[**delete_kafka_trigger**](KafkaTriggerApi.md#delete_kafka_trigger) | **DELETE** /w/{workspace}/kafka_triggers/delete/{path} | delete kafka trigger
[**exists_kafka_trigger**](KafkaTriggerApi.md#exists_kafka_trigger) | **GET** /w/{workspace}/kafka_triggers/exists/{path} | does kafka trigger exists
[**get_kafka_trigger**](KafkaTriggerApi.md#get_kafka_trigger) | **GET** /w/{workspace}/kafka_triggers/get/{path} | get kafka trigger
[**list_kafka_triggers**](KafkaTriggerApi.md#list_kafka_triggers) | **GET** /w/{workspace}/kafka_triggers/list | list kafka triggers
[**reset_kafka_offsets**](KafkaTriggerApi.md#reset_kafka_offsets) | **POST** /w/{workspace}/kafka_triggers/reset_offsets/{path} | reset kafka trigger offsets to earliest
[**set_kafka_trigger_mode**](KafkaTriggerApi.md#set_kafka_trigger_mode) | **POST** /w/{workspace}/kafka_triggers/setmode/{path} | set enabled kafka trigger
[**test_kafka_connection**](KafkaTriggerApi.md#test_kafka_connection) | **POST** /w/{workspace}/kafka_triggers/test | test kafka connection
[**update_kafka_trigger**](KafkaTriggerApi.md#update_kafka_trigger) | **POST** /w/{workspace}/kafka_triggers/update/{path} | update kafka trigger



## commit_kafka_offsets

> commit_kafka_offsets(workspace, path, commit_kafka_offsets_request)
commit kafka offsets for a specific trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**commit_kafka_offsets_request** | [**CommitKafkaOffsetsRequest**](CommitKafkaOffsetsRequest.md) | offsets to commit | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

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


## create_kafka_trigger

> String create_kafka_trigger(workspace, new_kafka_trigger)
create kafka trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_kafka_trigger** | [**NewKafkaTrigger**](NewKafkaTrigger.md) | new kafka 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_kafka_trigger

> String delete_kafka_trigger(workspace, path)
delete kafka 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_kafka_trigger

> bool exists_kafka_trigger(workspace, path)
does kafka 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_kafka_trigger

> models::KafkaTrigger get_kafka_trigger(workspace, path)
get kafka trigger

### Parameters


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

### Return type

[**models::KafkaTrigger**](KafkaTrigger.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_kafka_triggers

> Vec<models::KafkaTrigger> list_kafka_triggers(workspace, page, per_page, path, is_flow, path_start, label)
list kafka 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::KafkaTrigger>**](KafkaTrigger.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)


## reset_kafka_offsets

> reset_kafka_offsets(workspace, path)
reset kafka trigger offsets to earliest

### Parameters


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

> String set_kafka_trigger_mode(workspace, path, set_http_trigger_mode_request)
set enabled kafka trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**set_http_trigger_mode_request** | [**SetHttpTriggerModeRequest**](SetHttpTriggerModeRequest.md) | updated kafka 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_kafka_connection

> String test_kafka_connection(workspace, test_kafka_connection_request)
test kafka connection

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**test_kafka_connection_request** | [**TestKafkaConnectionRequest**](TestKafkaConnectionRequest.md) | test kafka 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_kafka_trigger

> String update_kafka_trigger(workspace, path, edit_kafka_trigger)
update kafka trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**edit_kafka_trigger** | [**EditKafkaTrigger**](EditKafkaTrigger.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)

