windmill-api 1.683.0

# \ScriptApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**archive_script_by_hash**](ScriptApi.md#archive_script_by_hash) | **POST** /w/{workspace}/scripts/archive/h/{hash} | archive script by hash
[**archive_script_by_path**](ScriptApi.md#archive_script_by_path) | **POST** /w/{workspace}/scripts/archive/p/{path} | archive script by path
[**create_script**](ScriptApi.md#create_script) | **POST** /w/{workspace}/scripts/create | create script
[**delete_script_by_hash**](ScriptApi.md#delete_script_by_hash) | **POST** /w/{workspace}/scripts/delete/h/{hash} | delete script by hash (erase content but keep hash, require admin)
[**delete_script_by_path**](ScriptApi.md#delete_script_by_path) | **POST** /w/{workspace}/scripts/delete/p/{path} | delete script at a given path (require admin)
[**delete_scripts_bulk**](ScriptApi.md#delete_scripts_bulk) | **DELETE** /w/{workspace}/scripts/delete_bulk | delete scripts in bulk
[**diff_raw_scripts_with_deployed**](ScriptApi.md#diff_raw_scripts_with_deployed) | **POST** /w/{workspace}/scripts/raw_temp/diff | diff local script hashes against deployed versions
[**exists_script_by_path**](ScriptApi.md#exists_script_by_path) | **GET** /w/{workspace}/scripts/exists/p/{path} | exists script by path
[**get_ci_test_results**](ScriptApi.md#get_ci_test_results) | **GET** /w/{workspace}/scripts/ci_test_results/{kind}/{path} | get CI test results for a script, flow, or resource
[**get_ci_test_results_batch**](ScriptApi.md#get_ci_test_results_batch) | **POST** /w/{workspace}/scripts/ci_test_results_batch | get CI test results for multiple items
[**get_hub_script_by_path**](ScriptApi.md#get_hub_script_by_path) | **GET** /scripts/hub/get_full/{path} | get full hub script by path
[**get_hub_script_content_by_path**](ScriptApi.md#get_hub_script_content_by_path) | **GET** /scripts/hub/get/{path} | get hub script content by path
[**get_script_by_hash**](ScriptApi.md#get_script_by_hash) | **GET** /w/{workspace}/scripts/get/h/{hash} | get script by hash
[**get_script_by_path**](ScriptApi.md#get_script_by_path) | **GET** /w/{workspace}/scripts/get/p/{path} | get script by path
[**get_script_by_path_with_draft**](ScriptApi.md#get_script_by_path_with_draft) | **GET** /w/{workspace}/scripts/get/draft/{path} | get script by path with draft
[**get_script_deployment_status**](ScriptApi.md#get_script_deployment_status) | **GET** /w/{workspace}/scripts/deployment_status/h/{hash} | get script deployment status
[**get_script_history_by_path**](ScriptApi.md#get_script_history_by_path) | **GET** /w/{workspace}/scripts/history/p/{path} | get history of a script by path
[**get_script_latest_version**](ScriptApi.md#get_script_latest_version) | **GET** /w/{workspace}/scripts/get_latest_version/{path} | get scripts's latest version (hash)
[**get_top_hub_scripts**](ScriptApi.md#get_top_hub_scripts) | **GET** /scripts/hub/top | get top hub scripts
[**get_triggers_count_of_script**](ScriptApi.md#get_triggers_count_of_script) | **GET** /w/{workspace}/scripts/get_triggers_count/{path} | get triggers count of script
[**list_dedicated_with_deps**](ScriptApi.md#list_dedicated_with_deps) | **GET** /w/{workspace}/scripts/list_dedicated_with_deps | list dedicated worker scripts with workspace dependency annotations
[**list_script_paths**](ScriptApi.md#list_script_paths) | **GET** /w/{workspace}/scripts/list_paths | list all scripts paths
[**list_script_paths_from_workspace_runnable**](ScriptApi.md#list_script_paths_from_workspace_runnable) | **GET** /w/{workspace}/scripts/list_paths_from_workspace_runnable/{path} | list script paths using provided script as a relative import
[**list_scripts**](ScriptApi.md#list_scripts) | **GET** /w/{workspace}/scripts/list | list all scripts
[**list_search_script**](ScriptApi.md#list_search_script) | **GET** /w/{workspace}/scripts/list_search | list scripts for search
[**list_tokens_of_script**](ScriptApi.md#list_tokens_of_script) | **GET** /w/{workspace}/scripts/list_tokens/{path} | get tokens with script scope
[**pick_hub_script_by_path**](ScriptApi.md#pick_hub_script_by_path) | **GET** /scripts/hub/pick/{path} | record hub script pick
[**query_hub_scripts**](ScriptApi.md#query_hub_scripts) | **GET** /embeddings/query_hub_scripts | query hub scripts by similarity
[**raw_script_by_hash**](ScriptApi.md#raw_script_by_hash) | **GET** /w/{workspace}/scripts/raw/h/{path} | raw script by hash
[**raw_script_by_path**](ScriptApi.md#raw_script_by_path) | **GET** /w/{workspace}/scripts/raw/p/{path} | raw script by path
[**raw_script_by_path_tokened**](ScriptApi.md#raw_script_by_path_tokened) | **GET** /scripts_u/tokened_raw/{workspace}/{token}/{path} | raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
[**store_raw_script_temp**](ScriptApi.md#store_raw_script_temp) | **POST** /w/{workspace}/scripts/raw_temp/store | store raw script content temporarily for CLI lock generation
[**toggle_workspace_error_handler_for_script**](ScriptApi.md#toggle_workspace_error_handler_for_script) | **POST** /w/{workspace}/scripts/toggle_workspace_error_handler/p/{path} | Toggle ON and OFF the workspace error handler for a given script
[**update_script_history**](ScriptApi.md#update_script_history) | **POST** /w/{workspace}/scripts/history_update/h/{hash}/p/{path} | update history of a script



## archive_script_by_hash

> models::Script archive_script_by_hash(workspace, hash)
archive script by hash

### Parameters


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

### Return type

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


## archive_script_by_path

> String archive_script_by_path(workspace, path)
archive script by path

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


## create_script

> String create_script(workspace, new_script)
create script

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_script** | [**NewScript**](NewScript.md) | Partially filled script | [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_script_by_hash

> models::Script delete_script_by_hash(workspace, hash)
delete script by hash (erase content but keep hash, require admin)

### Parameters


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

### Return type

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


## delete_script_by_path

> String delete_script_by_path(workspace, path, keep_captures)
delete script at a given path (require admin)

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


## delete_scripts_bulk

> Vec<String> delete_scripts_bulk(workspace, delete_variables_bulk_request)
delete scripts in bulk

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**delete_variables_bulk_request** | [**DeleteVariablesBulkRequest**](DeleteVariablesBulkRequest.md) | paths to delete | [required] |

### Return type

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


## diff_raw_scripts_with_deployed

> Vec<String> diff_raw_scripts_with_deployed(workspace, diff_raw_scripts_with_deployed_request)
diff local script hashes against deployed versions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**diff_raw_scripts_with_deployed_request** | [**DiffRawScriptsWithDeployedRequest**](DiffRawScriptsWithDeployedRequest.md) | scripts and workspace deps to diff against deployed versions | [required] |

### Return type

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


## exists_script_by_path

> bool exists_script_by_path(workspace, path)
exists script 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_ci_test_results

> Vec<models::CiTestResult> get_ci_test_results(workspace, kind, path)
get CI test results for a script, flow, or resource

### Parameters


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

### Return type

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

> std::collections::HashMap<String, Vec<models::CiTestResult>> get_ci_test_results_batch(workspace, get_ci_test_results_batch_request)
get CI test results for multiple items

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**get_ci_test_results_batch_request** | [**GetCiTestResultsBatchRequest**](GetCiTestResultsBatchRequest.md) |  | [required] |

### Return type

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


## get_hub_script_by_path

> models::GetHubScriptByPath200Response get_hub_script_by_path(path)
get full hub script by path

### Parameters


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

### Return type

[**models::GetHubScriptByPath200Response**](getHubScriptByPath_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_hub_script_content_by_path

> String get_hub_script_content_by_path(path)
get hub script content by path

### Parameters


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


## get_script_by_hash

> models::Script get_script_by_hash(workspace, hash, with_starred_info, authed)
get script by hash

### Parameters


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

### Return type

[**models::Script**](Script.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_script_by_path

> models::Script get_script_by_path(workspace, path, with_starred_info)
get script by path

### Parameters


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

### Return type

[**models::Script**](Script.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_script_by_path_with_draft

> models::NewScriptWithDraft get_script_by_path_with_draft(workspace, path)
get script by path with draft

### Parameters


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

### Return type

[**models::NewScriptWithDraft**](NewScriptWithDraft.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_script_deployment_status

> models::GetScriptDeploymentStatus200Response get_script_deployment_status(workspace, hash)
get script deployment status

### Parameters


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

### Return type

[**models::GetScriptDeploymentStatus200Response**](getScriptDeploymentStatus_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_script_history_by_path

> Vec<models::ScriptHistory> get_script_history_by_path(workspace, path)
get history of a script by path

### Parameters


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

### Return type

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

> models::ScriptHistory get_script_latest_version(workspace, path)
get scripts's latest version (hash)

### Parameters


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

### Return type

[**models::ScriptHistory**](ScriptHistory.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_top_hub_scripts

> models::GetTopHubScripts200Response get_top_hub_scripts(limit, app, kind)
get top hub scripts

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**f64**> | query limit |  |
**app** | Option<**String**> | query scripts app |  |
**kind** | Option<**String**> | query scripts kind |  |

### Return type

[**models::GetTopHubScripts200Response**](getTopHubScripts_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_script

> models::TriggersCount get_triggers_count_of_script(workspace, path)
get triggers count of script

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

> Vec<models::ListDedicatedWithDeps200ResponseInner> list_dedicated_with_deps(workspace)
list dedicated worker scripts with workspace dependency annotations

### Parameters


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

### Return type

[**Vec<models::ListDedicatedWithDeps200ResponseInner>**](listDedicatedWithDeps_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_script_paths

> Vec<String> list_script_paths(workspace)
list all scripts 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_script_paths_from_workspace_runnable

> Vec<String> list_script_paths_from_workspace_runnable(workspace, path)
list script paths using provided script as a relative import

### Parameters


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

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

> Vec<models::Script> list_scripts(workspace, page, per_page, order_desc, created_by, path_start, path_exact, first_parent_hash, last_parent_hash, parent_hash, show_archived, include_without_main, include_draft_only, is_template, kinds, starred_only, with_deployment_msg, languages, without_description, dedicated_worker, label)
list all scripts

### 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 |  |
**first_parent_hash** | Option<**String**> | mask to filter scripts whom first direct parent has exact hash |  |
**last_parent_hash** | Option<**String**> | mask to filter scripts whom last parent in the chain has exact hash. Beware that each script stores only a limited number of parents. Hence the last parent hash for a script is not necessarily its top-most parent. To find the top-most parent you will have to jump from last to last hash  until finding the parent  |  |
**parent_hash** | Option<**String**> | is the hash present in the array of stored parent hashes for this script. The same warning applies than for last_parent_hash. A script only store a limited number of direct parent  |  |
**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 ed.  |  |
**include_without_main** | Option<**bool**> | (default false) include scripts without an exported main function  |  |
**include_draft_only** | Option<**bool**> | (default false) include scripts that have no deployed version  |  |
**is_template** | Option<**bool**> | (default regardless) if true show only the templates if false show only the non templates if not defined, show all regardless of if the script is a template  |  |
**kinds** | Option<**String**> | (default regardless) script kinds to filter, split by comma  |  |
**starred_only** | Option<**bool**> | (default false) show only the starred items  |  |
**with_deployment_msg** | Option<**bool**> | (default false) include deployment message  |  |
**languages** | Option<**String**> | Filter to only include scripts written in the given languages. Accepts multiple values as a comma-separated list.  |  |
**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 scripts with dedicated_worker enabled. If false, show only scripts with dedicated_worker disabled.  |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

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

> Vec<models::ListSearchScript200ResponseInner> list_search_script(workspace)
list scripts for search

### Parameters


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

### Return type

[**Vec<models::ListSearchScript200ResponseInner>**](listSearchScript_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_script

> Vec<models::TruncatedToken> list_tokens_of_script(workspace, path)
get tokens with script 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)


## pick_hub_script_by_path

> models::PickHubScriptByPath200Response pick_hub_script_by_path(path)
record hub script pick

### Parameters


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

### Return type

[**models::PickHubScriptByPath200Response**](pickHubScriptByPath_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)


## query_hub_scripts

> Vec<models::QueryHubScripts200ResponseInner> query_hub_scripts(text, kind, limit, app)
query hub scripts by similarity

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**text** | **String** | query text | [required] |
**kind** | Option<**String**> | query scripts kind |  |
**limit** | Option<**f64**> | query limit |  |
**app** | Option<**String**> | query scripts app |  |

### Return type

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


## raw_script_by_hash

> String raw_script_by_hash(workspace, path)
raw script by hash

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


## raw_script_by_path

> String raw_script_by_path(workspace, path)
raw script by path

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


## raw_script_by_path_tokened

> String raw_script_by_path_tokened(workspace, token, path)
raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**token** | **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)


## store_raw_script_temp

> String store_raw_script_temp(workspace, body)
store raw script content temporarily for CLI lock generation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**body** | **String** | script content to store | [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)


## toggle_workspace_error_handler_for_script

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

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

> String update_script_history(workspace, hash, path, update_script_history_request)
update history of a script

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**hash** | **String** |  | [required] |
**path** | **String** |  | [required] |
**update_script_history_request** | [**UpdateScriptHistoryRequest**](UpdateScriptHistoryRequest.md) | Script 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)