# \FlowApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**archive_flow_by_path**](FlowApi.md#archive_flow_by_path) | **POST** /w/{workspace}/flows/archive/{path} | archive flow by path
[**create_flow**](FlowApi.md#create_flow) | **POST** /w/{workspace}/flows/create | create flow
[**delete_flow_by_path**](FlowApi.md#delete_flow_by_path) | **DELETE** /w/{workspace}/flows/delete/{path} | delete flow by path
[**exists_flow_by_path**](FlowApi.md#exists_flow_by_path) | **GET** /w/{workspace}/flows/exists/{path} | exists flow by path
[**get_flow_by_path**](FlowApi.md#get_flow_by_path) | **GET** /w/{workspace}/flows/get/{path} | get flow by path
[**get_flow_by_path_with_draft**](FlowApi.md#get_flow_by_path_with_draft) | **GET** /w/{workspace}/flows/get/draft/{path} | get flow by path with draft
[**get_flow_deployment_status**](FlowApi.md#get_flow_deployment_status) | **GET** /w/{workspace}/flows/deployment_status/p/{path} | get flow deployment status
[**get_flow_history**](FlowApi.md#get_flow_history) | **GET** /w/{workspace}/flows/history/p/{path} | get flow history by path
[**get_flow_latest_version**](FlowApi.md#get_flow_latest_version) | **GET** /w/{workspace}/flows/get_latest_version/{path} | get flow's latest version
[**get_flow_version**](FlowApi.md#get_flow_version) | **GET** /w/{workspace}/flows/get/v/{version} | get flow version
[**get_hub_flow_by_id**](FlowApi.md#get_hub_flow_by_id) | **GET** /flows/hub/get/{id} | get hub flow by id
[**get_triggers_count_of_flow**](FlowApi.md#get_triggers_count_of_flow) | **GET** /w/{workspace}/flows/get_triggers_count/{path} | get triggers count of flow
[**list_flow_paths**](FlowApi.md#list_flow_paths) | **GET** /w/{workspace}/flows/list_paths | list all flow paths
[**list_flow_paths_from_workspace_runnable**](FlowApi.md#list_flow_paths_from_workspace_runnable) | **GET** /w/{workspace}/flows/list_paths_from_workspace_runnable/{runnable_kind}/{path} | list flow paths from workspace runnable
[**list_flows**](FlowApi.md#list_flows) | **GET** /w/{workspace}/flows/list | list all flows
[**list_hub_flows**](FlowApi.md#list_hub_flows) | **GET** /flows/hub/list | list all hub flows
[**list_search_flow**](FlowApi.md#list_search_flow) | **GET** /w/{workspace}/flows/list_search | list flows for search
[**list_tokens_of_flow**](FlowApi.md#list_tokens_of_flow) | **GET** /w/{workspace}/flows/list_tokens/{path} | get tokens with flow scope
[**toggle_workspace_error_handler_for_flow**](FlowApi.md#toggle_workspace_error_handler_for_flow) | **POST** /w/{workspace}/flows/toggle_workspace_error_handler/{path} | Toggle ON and OFF the workspace error handler for a given flow
[**update_flow**](FlowApi.md#update_flow) | **POST** /w/{workspace}/flows/update/{path} | update flow
[**update_flow_history**](FlowApi.md#update_flow_history) | **POST** /w/{workspace}/flows/history_update/v/{version} | update flow history



## archive_flow_by_path

> String archive_flow_by_path(workspace, path, archive_flow_by_path_request)
archive flow by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**archive_flow_by_path_request** | [**ArchiveFlowByPathRequest**](ArchiveFlowByPathRequest.md) | archiveFlow | [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)


## create_flow

> String create_flow(workspace, create_flow_request)
create flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_flow_request** | [**CreateFlowRequest**](CreateFlowRequest.md) | Partially filled flow | [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_flow_by_path

> String delete_flow_by_path(workspace, path, keep_captures)
delete flow by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**keep_captures** | Option<**bool**> | keep captures |  |

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

> bool exists_flow_by_path(workspace, path)
exists flow by path

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

> models::Flow get_flow_by_path(workspace, path, with_starred_info)
get flow by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**with_starred_info** | Option<**bool**> |  |  |

### Return type

[**models::Flow**](Flow.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_flow_by_path_with_draft

> models::GetFlowByPathWithDraft200Response get_flow_by_path_with_draft(workspace, path)
get flow by path with draft

### Parameters


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

### Return type

[**models::GetFlowByPathWithDraft200Response**](getFlowByPathWithDraft_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_flow_deployment_status

> models::GetFlowDeploymentStatus200Response get_flow_deployment_status(workspace, path)
get flow deployment status

### Parameters


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

### Return type

[**models::GetFlowDeploymentStatus200Response**](getFlowDeploymentStatus_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_flow_history

> Vec<models::FlowVersion> get_flow_history(workspace, path)
get flow history by path

### Parameters


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

### Return type

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

> models::FlowVersion get_flow_latest_version(workspace, path)
get flow's latest version

### Parameters


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

### Return type

[**models::FlowVersion**](FlowVersion.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_flow_version

> models::Flow get_flow_version(workspace, version)
get flow version

### Parameters


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

### Return type

[**models::Flow**](Flow.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_hub_flow_by_id

> models::GetHubFlowById200Response get_hub_flow_by_id(id)
get hub flow by id

### Parameters


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

### Return type

[**models::GetHubFlowById200Response**](getHubFlowById_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_triggers_count_of_flow

> models::TriggersCount get_triggers_count_of_flow(workspace, path)
get triggers count of flow

### Parameters


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

### Return type

[**models::TriggersCount**](TriggersCount.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_flow_paths

> Vec<String> list_flow_paths(workspace)
list all flow paths

### Parameters


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

### Return type

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


## list_flow_paths_from_workspace_runnable

> Vec<String> list_flow_paths_from_workspace_runnable(workspace, runnable_kind, path, match_path_start)
list flow paths from workspace runnable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**runnable_kind** | **String** |  | [required] |
**path** | **String** |  | [required] |
**match_path_start** | Option<**bool**> |  |  |

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


## list_flows

> Vec<models::ListFlows200ResponseInner> list_flows(workspace, page, per_page, order_desc, created_by, path_start, path_exact, show_archived, starred_only, include_draft_only, with_deployment_msg, without_description, dedicated_worker, label)
list all flows

### 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) |  |
**order_desc** | Option<**bool**> | order by desc order (default true) |  |
**created_by** | Option<**String**> | filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob') |  |
**path_start** | Option<**String**> | mask to filter matching starting path |  |
**path_exact** | Option<**String**> | mask to filter exact matching path |  |
**show_archived** | Option<**bool**> | (default false) show only the archived files. when multiple archived hash share the same path, only the ones with the latest create_at are displayed.  |  |
**starred_only** | Option<**bool**> | (default false) show only the starred items  |  |
**include_draft_only** | Option<**bool**> | (default false) include items that have no deployed version  |  |
**with_deployment_msg** | Option<**bool**> | (default false) include deployment message  |  |
**without_description** | Option<**bool**> | (default false) If true, the description field will be omitted from the response.  |  |
**dedicated_worker** | Option<**bool**> | (default regardless) If true, show only flows with dedicated_worker enabled. If false, show only flows with dedicated_worker disabled.  |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

[**Vec<models::ListFlows200ResponseInner>**](listFlows_200_response_inner.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_hub_flows

> models::ListHubFlows200Response list_hub_flows()
list all hub flows

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListHubFlows200Response**](listHubFlows_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_search_flow

> Vec<models::ListSearchResource200ResponseInner> list_search_flow(workspace)
list flows for search

### Parameters


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

### Return type

[**Vec<models::ListSearchResource200ResponseInner>**](listSearchResource_200_response_inner.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_tokens_of_flow

> Vec<models::TruncatedToken> list_tokens_of_flow(workspace, path)
get tokens with flow scope

### Parameters


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

### Return type

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


## toggle_workspace_error_handler_for_flow

> String toggle_workspace_error_handler_for_flow(workspace, path, toggle_workspace_error_handler_for_script_request)
Toggle ON and OFF the workspace error handler for a given flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**toggle_workspace_error_handler_for_script_request** | [**ToggleWorkspaceErrorHandlerForScriptRequest**](ToggleWorkspaceErrorHandlerForScriptRequest.md) | Workspace error handler enabled | [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_flow

> String update_flow(workspace, path, update_flow_request)
update flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**update_flow_request** | [**UpdateFlowRequest**](UpdateFlowRequest.md) | Partially filled flow | [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_flow_history

> String update_flow_history(workspace, version, update_flow_history_request)
update flow history

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**version** | **f64** |  | [required] |
**update_flow_history_request** | [**UpdateFlowHistoryRequest**](UpdateFlowHistoryRequest.md) | Flow deployment message | [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)

