windmill-api 1.740.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation

Rust API client for windmill-api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit https://windmill.dev

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.740.0
  • Package version: 1.740.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named windmill-api and add the following to Cargo.toml under [dependencies]:

windmill-api = { path = "./windmill-api" }

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
AdminApi convert_user_to_group POST /w/{workspace}/users/convert_to_group/{username} convert manual user to group user (require admin privilege)
AdminApi delete_user DELETE /w/{workspace}/users/delete/{username} delete user (require admin privilege)
AdminApi get_user GET /w/{workspace}/users/get/{username} get user (require admin privilege)
AdminApi offboard_preview GET /w/{workspace}/users/offboard_preview/{username} preview offboarding for a workspace user (require admin privilege)
AdminApi offboard_workspace_user POST /w/{workspace}/users/offboard/{username} offboard a workspace user (reassign objects, optionally delete user)
AdminApi update_user POST /w/{workspace}/users/update/{username} update user (require admin privilege)
AgentWorkersApi blacklist_agent_token POST /agent_workers/blacklist_token blacklist agent token (requires super admin)
AgentWorkersApi create_agent_token POST /agent_workers/create_agent_token create agent token
AgentWorkersApi get_min_version GET /agent_workers/get_min_version get minimum worker version across all workers
AgentWorkersApi list_blacklisted_agent_tokens GET /agent_workers/list_blacklisted_tokens list blacklisted agent tokens (requires super admin)
AgentWorkersApi remove_blacklist_agent_token POST /agent_workers/remove_blacklist_token remove agent token from blacklist (requires super admin)
AppApi create_app POST /w/{workspace}/apps/create create app
AppApi custom_path_exists GET /w/{workspace}/apps/custom_path_exists/{custom_path} check if custom path exists
AppApi delete_app DELETE /w/{workspace}/apps/delete/{path} delete app
AppApi delete_s3_file_from_app DELETE /w/{workspace}/apps_u/delete_s3_file delete s3 file from app
AppApi execute_component POST /w/{workspace}/apps_u/execute_component/{path} executeComponent
AppApi exists_app GET /w/{workspace}/apps/exists/{path} does an app exisst at path
AppApi get_app_by_path GET /w/{workspace}/apps/get/p/{path} get app by path
AppApi get_app_by_version GET /w/{workspace}/apps/get/v/{id} get app by version
AppApi get_app_embed_token_by_custom_path GET /apps_u/embed_token_by_custom_path/{custom_path} get app embed token by custom path
AppApi get_app_embed_token_by_path GET /w/{workspace}/apps/embed_token/p/{path} get app embed token by path
AppApi get_app_embed_token_by_secret GET /w/{workspace}/apps_u/embed_token/{secret} get app embed token by secret
AppApi get_app_history_by_path GET /w/{workspace}/apps/history/p/{path} get app history by path
AppApi get_app_latest_version GET /w/{workspace}/apps/get_latest_version/{path} get apps's latest version
AppApi get_app_lite_by_path GET /w/{workspace}/apps/get/lite/{path} get app lite by path
AppApi get_hub_app_by_id GET /apps/hub/get/{id} get hub app by id
AppApi get_hub_raw_app_by_id GET /apps/hub/get_raw/{id} get hub raw app by id
AppApi get_public_app_by_custom_path GET /apps_u/public_app_by_custom_path/{custom_path} get public app by custom path
AppApi get_public_app_by_secret GET /w/{workspace}/apps_u/public_app/{path} get public app by secret
AppApi get_public_resource GET /w/{workspace}/apps_u/public_resource/{path} get public resource
AppApi get_public_secret_of_app GET /w/{workspace}/apps/secret_of/{path} get public secret of app
AppApi get_public_secret_of_latest_version_of_app GET /w/{workspace}/apps/secret_of_latest_version/{path} get public secret of latest version of an app bundle
AppApi get_raw_app_data GET /w/{workspace}/apps/get_data/v/{secretWithExtension} get raw app data by
AppApi list_app_paths_from_workspace_runnable GET /w/{workspace}/apps/list_paths_from_workspace_runnable/{runnable_kind}/{path} list app paths from workspace runnable
AppApi list_apps GET /w/{workspace}/apps/list list all apps
AppApi list_hub_apps GET /apps/hub/list list all hub apps
AppApi list_search_app GET /w/{workspace}/apps/list_search list apps for search
AppApi sign_s3_objects POST /w/{workspace}/apps/sign_s3_objects sign s3 objects, to be used by anonymous users in public apps
AppApi update_app POST /w/{workspace}/apps/update/{path} update app
AppApi update_app_history POST /w/{workspace}/apps/history_update/a/{id}/v/{version} update app history
AppApi upload_s3_file_from_app POST /w/{workspace}/apps_u/upload_s3_file/{path} upload s3 file from app
AssetApi get_assets_graph GET /w/{workspace}/assets/graph Get the workspace-wide asset <-> runnable graph
AssetApi list_assets GET /w/{workspace}/assets/list List all assets in the workspace with cursor pagination
AssetApi list_assets_by_usage POST /w/{workspace}/assets/list_by_usages List all assets used by given usages paths
AssetApi list_favorite_assets GET /w/{workspace}/assets/list_favorites List all favorite assets for the authenticated user
AssetApi list_pipeline_folders GET /w/{workspace}/assets/pipelines List folders that contain at least one pipeline-member script
AuditApi get_audit_log GET /w/{workspace}/audit/get/{id} get audit log (requires admin privilege)
AuditApi list_audit_logs GET /w/{workspace}/audit/list list audit logs (requires admin privilege)
AzureTriggerApi create_azure_trigger POST /w/{workspace}/azure_triggers/create create an Azure Event Grid trigger
AzureTriggerApi delete_azure_subscription DELETE /w/{workspace}/azure_triggers/subscriptions/delete/{path} delete an Event Grid subscription on Azure
AzureTriggerApi delete_azure_trigger DELETE /w/{workspace}/azure_triggers/delete/{path} delete an Azure Event Grid trigger
AzureTriggerApi exists_azure_trigger GET /w/{workspace}/azure_triggers/exists/{path} check whether an azure trigger exists
AzureTriggerApi get_azure_trigger GET /w/{workspace}/azure_triggers/get/{path} get an Azure Event Grid trigger
AzureTriggerApi list_azure_basic_topics POST /w/{workspace}/azure_triggers/basic/topics/list/{path} list Basic Event Grid topics + system topics the service principal can access
AzureTriggerApi list_azure_namespace_subscriptions POST /w/{workspace}/azure_triggers/namespaces/subscriptions/list/{path} list subscriptions under a Namespace topic
AzureTriggerApi list_azure_namespace_topics POST /w/{workspace}/azure_triggers/namespaces/topics/list/{path} list topics under an Event Grid Namespace
AzureTriggerApi list_azure_namespaces POST /w/{workspace}/azure_triggers/namespaces/list/{path} list Event Grid Namespaces the service principal can access
AzureTriggerApi list_azure_triggers GET /w/{workspace}/azure_triggers/list list azure triggers
AzureTriggerApi set_azure_trigger_mode POST /w/{workspace}/azure_triggers/setmode/{path} set azure trigger mode
AzureTriggerApi test_azure_connection POST /w/{workspace}/azure_triggers/test test Azure service principal connection
AzureTriggerApi update_azure_trigger POST /w/{workspace}/azure_triggers/update/{path} update an Azure Event Grid trigger
CaptureApi delete_capture DELETE /w/{workspace}/capture/{id} delete a capture
CaptureApi get_capture GET /w/{workspace}/capture/{id} get a capture
CaptureApi get_capture_configs GET /w/{workspace}/capture/get_configs/{runnable_kind}/{path} get capture configs for a script or flow
CaptureApi list_captures GET /w/{workspace}/capture/list/{runnable_kind}/{path} list captures for a script or flow
CaptureApi move_captures_and_configs POST /w/{workspace}/capture/move/{runnable_kind}/{path} move captures and configs for a script or flow
CaptureApi ping_capture_config POST /w/{workspace}/capture/ping_config/{trigger_kind}/{runnable_kind}/{path} ping capture config
CaptureApi set_capture_config POST /w/{workspace}/capture/set_config set capture config
ConcurrencyGroupsApi delete_concurrency_group DELETE /concurrency_groups/prune/{concurrency_id} Delete concurrency group
ConcurrencyGroupsApi get_concurrency_key GET /concurrency_groups/{id}/key Get the concurrency key for a job that has concurrency limits enabled
ConcurrencyGroupsApi list_concurrency_groups GET /concurrency_groups/list List all concurrency groups
ConcurrencyGroupsApi list_extended_jobs GET /w/{workspace}/concurrency_groups/list_jobs Get intervals of job runtime concurrency
ConfigApi delete_config DELETE /configs/update/{name} Delete Config
ConfigApi get_config GET /configs/get/{name} get config
ConfigApi list_all_dedicated_with_deps GET /configs/list_all_dedicated_with_deps list all dedicated scripts with their dependencies
ConfigApi list_all_workspace_dependencies GET /configs/list_all_workspace_dependencies list all workspace dependencies
ConfigApi list_autoscaling_events GET /configs/list_autoscaling_events/{worker_group} List autoscaling events
ConfigApi list_available_python_versions GET /configs/list_available_python_versions Get currently available python versions provided by UV.
ConfigApi list_configs GET /configs/list list configs
ConfigApi list_worker_groups GET /configs/list_worker_groups list worker groups
ConfigApi native_kubernetes_autoscaling_healthcheck GET /configs/native_kubernetes_autoscaling_healthcheck Check Kubernetes autoscaling health for a worker group
ConfigApi update_config POST /configs/update/{name} Update config
DocumentationApi read_docs_page GET /docs/page Fetch the markdown of a single Windmill documentation page. Provide the url of a page found via searchDocs (its Source URL). If the page is large, this returns its list of section headings instead of the full content; call again with the section argument set to one of those headings to read that section.
DocumentationApi search_docs GET /docs/search Full-text search across the entire Windmill documentation. Provide one or more keywords; returns the most relevant docs pages, each with its Source URL and short matching snippets. Use this FIRST to find relevant pages by their content (a flag, function, error message, config key or concept). If the snippets answer the question, answer directly; otherwise call readDocsPage with a returned Source URL to read more.
DraftApi get_draft_for_user GET /w/{workspace}/drafts/get/{kind}/{path} fetch a single draft's content by workspace username (or the legacy workspace-level row)
DraftApi get_own_draft GET /w/{workspace}/drafts/get_own/{kind}/{path} fetch the current user's own draft content at a path (any kind)
DraftApi list_drafts GET /w/{workspace}/drafts/list list every draft the current user has in this workspace, across all kinds
DraftApi migrate_legacy_draft POST /w/{workspace}/drafts/migrate_legacy/{kind}/{path} resolve a legacy (workspace-level) draft (admin only)
DraftApi update_draft POST /w/{workspace}/drafts/update/{kind}/{path} upsert (or clear) the current user's draft at a path
EmailTriggerApi create_email_trigger POST /w/{workspace}/email_triggers/create create email trigger
EmailTriggerApi delete_email_trigger DELETE /w/{workspace}/email_triggers/delete/{path} delete email trigger
EmailTriggerApi exists_email_local_part POST /w/{workspace}/email_triggers/local_part_exists does email local part exists
EmailTriggerApi exists_email_trigger GET /w/{workspace}/email_triggers/exists/{path} does email trigger exists
EmailTriggerApi get_email_trigger GET /w/{workspace}/email_triggers/get/{path} get email trigger
EmailTriggerApi list_email_triggers GET /w/{workspace}/email_triggers/list list email triggers
EmailTriggerApi set_email_trigger_mode POST /w/{workspace}/email_triggers/setmode/{path} enable/disable email trigger
EmailTriggerApi update_email_trigger POST /w/{workspace}/email_triggers/update/{path} update email trigger
FavoriteApi star POST /w/{workspace}/favorites/star star item
FavoriteApi unstar POST /w/{workspace}/favorites/unstar unstar item
FlowApi archive_flow_by_path POST /w/{workspace}/flows/archive/{path} archive flow by path
FlowApi create_flow POST /w/{workspace}/flows/create create flow
FlowApi delete_flow_by_path DELETE /w/{workspace}/flows/delete/{path} delete flow by path
FlowApi exists_flow_by_path GET /w/{workspace}/flows/exists/{path} exists flow by path
FlowApi get_flow_by_path GET /w/{workspace}/flows/get/{path} get flow by path
FlowApi get_flow_deployment_status GET /w/{workspace}/flows/deployment_status/p/{path} get flow deployment status
FlowApi get_flow_history GET /w/{workspace}/flows/history/p/{path} get flow history by path
FlowApi get_flow_latest_version GET /w/{workspace}/flows/get_latest_version/{path} get flow's latest version
FlowApi get_flow_version GET /w/{workspace}/flows/get/v/{version} get flow version
FlowApi get_hub_flow_by_id GET /flows/hub/get/{id} get hub flow by id
FlowApi get_triggers_count_of_flow GET /w/{workspace}/flows/get_triggers_count/{path} get triggers count of flow
FlowApi list_flow_paths GET /w/{workspace}/flows/list_paths list all flow paths
FlowApi list_flow_paths_from_workspace_runnable GET /w/{workspace}/flows/list_paths_from_workspace_runnable/{runnable_kind}/{path} list flow paths from workspace runnable
FlowApi list_flows GET /w/{workspace}/flows/list list all flows
FlowApi list_hub_flows GET /flows/hub/list list all hub flows
FlowApi list_search_flow GET /w/{workspace}/flows/list_search list flows for search
FlowApi list_tokens_of_flow GET /w/{workspace}/flows/list_tokens/{path} get tokens with flow scope
FlowApi 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
FlowApi update_flow POST /w/{workspace}/flows/update/{path} update flow
FlowApi update_flow_history POST /w/{workspace}/flows/history_update/v/{version} update flow history
FlowConversationsApi delete_flow_conversation DELETE /w/{workspace}/flow_conversations/delete/{conversation_id} delete flow conversation
FlowConversationsApi list_conversation_messages GET /w/{workspace}/flow_conversations/{conversation_id}/messages list conversation messages
FlowConversationsApi list_flow_conversations GET /w/{workspace}/flow_conversations/list list flow conversations
FolderApi add_owner_to_folder POST /w/{workspace}/folders/addowner/{name} add owner to folder
FolderApi create_folder POST /w/{workspace}/folders/create create folder
FolderApi delete_folder DELETE /w/{workspace}/folders/delete/{name} delete folder
FolderApi exists_folder GET /w/{workspace}/folders/exists/{name} exists folder
FolderApi get_folder GET /w/{workspace}/folders/get/{name} get folder
FolderApi get_folder_permission_history GET /w/{workspace}/folders_history/get/{name} get folder permission history
FolderApi get_folder_usage GET /w/{workspace}/folders/getusage/{name} get folder usage
FolderApi list_folder_names GET /w/{workspace}/folders/listnames list folder names
FolderApi list_folders GET /w/{workspace}/folders/list list folders
FolderApi remove_owner_to_folder POST /w/{workspace}/folders/removeowner/{name} remove owner to folder
FolderApi update_folder POST /w/{workspace}/folders/update/{name} update folder
GcpTriggerApi create_gcp_trigger POST /w/{workspace}/gcp_triggers/create create gcp trigger
GcpTriggerApi delete_gcp_subscription DELETE /w/{workspace}/gcp_triggers/subscriptions/delete/{path} delete gcp trigger
GcpTriggerApi delete_gcp_trigger DELETE /w/{workspace}/gcp_triggers/delete/{path} delete gcp trigger
GcpTriggerApi exists_gcp_trigger GET /w/{workspace}/gcp_triggers/exists/{path} does gcp trigger exists
GcpTriggerApi get_gcp_trigger GET /w/{workspace}/gcp_triggers/get/{path} get gcp trigger
GcpTriggerApi list_all_t_google_topic_subscriptions POST /w/{workspace}/gcp_triggers/subscriptions/list/{path} list all subscription of a give topic from google cloud service
GcpTriggerApi list_gcp_triggers GET /w/{workspace}/gcp_triggers/list list gcp triggers
GcpTriggerApi list_google_topics GET /w/{workspace}/gcp_triggers/topics/list/{path} list all topics of google cloud service
GcpTriggerApi set_gcp_trigger_mode POST /w/{workspace}/gcp_triggers/setmode/{path} set enabled gcp trigger
GcpTriggerApi test_gcp_connection POST /w/{workspace}/gcp_triggers/test test gcp connection
GcpTriggerApi update_gcp_trigger POST /w/{workspace}/gcp_triggers/update/{path} update gcp trigger
GitSyncApi assign_ghes_installation POST /github_app/ghes/assign Assign GHES installation to a workspace
GitSyncApi delete_from_workspace DELETE /w/{workspace}/github_app/installation/{installation_id} Delete a GitHub installation from a workspace
GitSyncApi discover_ghes_installations GET /github_app/ghes/discover Discover GHES App installations
GitSyncApi export_installation GET /w/{workspace}/github_app/export/{installationId} Export GitHub installation JWT token
GitSyncApi get_ghes_config GET /github_app/ghes_config Get GHES app config
GitSyncApi get_global_connected_repositories GET /github_app/connected_repositories get connected repositories
GitSyncApi ghes_installation_callback POST /w/{workspace}/github_app/ghes_installation_callback GHES installation callback
GitSyncApi import_installation POST /w/{workspace}/github_app/import Import GitHub installation from JWT token
GitSyncApi install_from_workspace POST /w/{workspace}/github_app/install_from_workspace Install a GitHub installation from another workspace
GitSyncApi unassign_ghes_installation DELETE /github_app/ghes/assign/{workspace_id}/{installation_id} Unassign GHES installation from a workspace
GranularAclApi add_granular_acls POST /w/{workspace}/acls/add/{kind}/{path} add granular acls
GranularAclApi get_granular_acls GET /w/{workspace}/acls/get/{kind}/{path} get granular acls
GranularAclApi remove_granular_acls POST /w/{workspace}/acls/remove/{kind}/{path} remove granular acls
GroupApi add_user_to_group POST /w/{workspace}/groups/adduser/{name} add user to group
GroupApi add_user_to_instance_group POST /groups/adduser/{name} add user to instance group
GroupApi create_group POST /w/{workspace}/groups/create create group
GroupApi create_instance_group POST /groups/create create instance group
GroupApi delete_group DELETE /w/{workspace}/groups/delete/{name} delete group
GroupApi delete_instance_group DELETE /groups/delete/{name} delete instance group
GroupApi export_instance_groups GET /groups/export export instance groups
GroupApi get_group GET /w/{workspace}/groups/get/{name} get group
GroupApi get_group_permission_history GET /w/{workspace}/groups_history/get/{name} get group permission history
GroupApi get_instance_group GET /groups/get/{name} get instance group
GroupApi list_group_names GET /w/{workspace}/groups/listnames list group names
GroupApi list_groups GET /w/{workspace}/groups/list list groups
GroupApi list_instance_groups GET /groups/list list instance groups
GroupApi list_instance_groups_with_workspaces GET /groups/list_with_workspaces list instance groups with workspace information
GroupApi overwrite_instance_groups POST /groups/overwrite overwrite instance groups
GroupApi remove_user_from_instance_group POST /groups/removeuser/{name} remove user from instance group
GroupApi remove_user_to_group POST /w/{workspace}/groups/removeuser/{name} remove user to group
GroupApi update_group POST /w/{workspace}/groups/update/{name} update group
GroupApi update_instance_group POST /groups/update/{name} update instance group
HealthApi get_health_detailed GET /health/detailed detailed health status
HealthApi get_health_status GET /health/status health status
HelpersApi check_s3_folder_exists GET /w/{workspace}/job_helpers/check_s3_folder_exists Check if S3 path exists and is a folder
HelpersApi dataset_storage_test_connection GET /w/{workspace}/job_helpers/test_connection Test connection to the workspace object storage
HelpersApi delete_s3_file DELETE /w/{workspace}/job_helpers/delete_s3_file Permanently delete file from S3
HelpersApi duckdb_connection_settings POST /w/{workspace}/job_helpers/duckdb_connection_settings Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
HelpersApi duckdb_connection_settings_v2 POST /w/{workspace}/job_helpers/v2/duckdb_connection_settings Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
HelpersApi file_download GET /w/{workspace}/job_helpers/download_s3_file Download file from S3 bucket
HelpersApi file_download_parquet_as_csv GET /w/{workspace}/job_helpers/download_s3_parquet_file_as_csv Download file to S3 bucket
HelpersApi file_upload POST /w/{workspace}/job_helpers/upload_s3_file Upload file to S3 bucket
HelpersApi git_repo_viewer_file_upload POST /w/{workspace}/job_helpers/upload_git_repo_file_to_instance_storage Upload a file to the instance storage gitrepos section for viewing
HelpersApi list_git_repo_files GET /w/{workspace}/job_helpers/list_git_repo_files List the file keys available in instance object storage with resource-based access control
HelpersApi list_stored_files GET /w/{workspace}/job_helpers/list_stored_files List the file keys available in a workspace object storage
HelpersApi load_csv_preview GET /w/{workspace}/job_helpers/load_csv_preview/{path} Load a preview of a csv file
HelpersApi load_file_metadata GET /w/{workspace}/job_helpers/load_file_metadata Load metadata of the file
HelpersApi load_file_preview GET /w/{workspace}/job_helpers/load_file_preview Load a preview of the file
HelpersApi load_git_repo_file_metadata GET /w/{workspace}/job_helpers/load_git_repo_file_metadata Load file metadata from instance storage with resource-based access control
HelpersApi load_git_repo_file_preview GET /w/{workspace}/job_helpers/load_git_repo_file_preview Load a preview of a file from instance storage with resource-based access control
HelpersApi load_parquet_preview GET /w/{workspace}/job_helpers/load_parquet_preview/{path} Load a preview of a parquet file
HelpersApi load_table_row_count GET /w/{workspace}/job_helpers/load_table_count/{path} Load the table row count
HelpersApi move_s3_file GET /w/{workspace}/job_helpers/move_s3_file Move a S3 file from one path to the other within the same bucket
HelpersApi polars_connection_settings POST /w/{workspace}/job_helpers/polars_connection_settings Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
HelpersApi polars_connection_settings_v2 POST /w/{workspace}/job_helpers/v2/polars_connection_settings Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
HelpersApi s3_resource_info POST /w/{workspace}/job_helpers/v2/s3_resource_info Returns the s3 resource associated to the provided path, or the workspace default S3 resource
HttpTriggerApi create_http_trigger POST /w/{workspace}/http_triggers/create create http trigger
HttpTriggerApi create_http_triggers POST /w/{workspace}/http_triggers/create_many create many HTTP triggers
HttpTriggerApi delete_http_trigger DELETE /w/{workspace}/http_triggers/delete/{path} delete http trigger
HttpTriggerApi exists_http_trigger GET /w/{workspace}/http_triggers/exists/{path} does http trigger exists
HttpTriggerApi exists_route POST /w/{workspace}/http_triggers/route_exists does route exists
HttpTriggerApi get_http_trigger GET /w/{workspace}/http_triggers/get/{path} get http trigger
HttpTriggerApi list_http_triggers GET /w/{workspace}/http_triggers/list list http triggers
HttpTriggerApi set_http_trigger_mode POST /w/{workspace}/http_triggers/setmode/{path} enable/disable http trigger
HttpTriggerApi update_http_trigger POST /w/{workspace}/http_triggers/update/{path} update http trigger
IndexSearchApi clear_index DELETE /indexer/delete/{idx_name} Clear an index and restart the indexer.
IndexSearchApi count_search_logs_index GET /srch/index/search/count_service_logs Search and count the log line hits on every provided host
IndexSearchApi get_index_disk_storage_sizes GET /srch/index/storage/disk Get index disk storage sizes from the indexer.
IndexSearchApi get_index_storage_sizes GET /indexer/storage Get index storage sizes (disk and S3).
IndexSearchApi get_indexer_status GET /indexer/status Get indexer status including liveness and storage sizes.
IndexSearchApi search_jobs_index GET /srch/w/{workspace}/index/search/job Search through jobs with a string query
IndexSearchApi search_logs_index GET /srch/index/search/service_logs Search through service logs with a string query
InputApi create_input POST /w/{workspace}/inputs/create Create an Input for future use in a script or flow
InputApi delete_input POST /w/{workspace}/inputs/delete/{input} Delete a Saved Input
InputApi get_args_from_history_or_saved_input GET /w/{workspace}/inputs/{jobOrInputId}/args Get args from history or saved input
InputApi get_input_history GET /w/{workspace}/inputs/history List Inputs used in previously completed jobs
InputApi list_inputs GET /w/{workspace}/inputs/list List saved Inputs for a Runnable
InputApi update_input POST /w/{workspace}/inputs/update Update an Input
IntegrationApi list_hub_integrations GET /integrations/hub/list list hub integrations
JobApi batch_re_run_jobs POST /w/{workspace}/jobs/run/batch_rerun_jobs re-run multiple jobs
JobApi cancel_persistent_queued_jobs POST /w/{workspace}/jobs_u/queue/cancel_persistent/{path} cancel all queued jobs for persistent script
JobApi cancel_queued_job POST /w/{workspace}/jobs_u/queue/cancel/{id} cancel queued or running job
JobApi cancel_selection POST /w/{workspace}/jobs/queue/cancel_selection cancel jobs based on the given uuids
JobApi cancel_suspended_job_get GET /w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature} cancel a job for a suspended flow
JobApi cancel_suspended_job_post POST /w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature} cancel a job for a suspended flow
JobApi count_completed_jobs GET /w/{workspace}/jobs/completed/count_jobs count number of completed jobs with filter
JobApi count_jobs_by_tag GET /jobs/completed/count_by_tag Count jobs by tag
JobApi create_job_signature GET /w/{workspace}/jobs/job_signature/{id}/{resume_id} create an HMac signature given a job id and a resume id
JobApi delete_completed_job POST /w/{workspace}/jobs/completed/delete/{id} delete completed job (erase content but keep run id)
JobApi delete_jobs POST /w/{workspace}/jobs/delete delete jobs by IDs from all related tables
JobApi export_completed_jobs GET /w/{workspace}/jobs/completed/export export all completed jobs for backup/migration
JobApi export_queued_jobs GET /w/{workspace}/jobs/queue/export export all queued jobs for backup/migration
JobApi force_cancel_queued_job POST /w/{workspace}/jobs_u/queue/force_cancel/{id} force cancel queued job
JobApi get_approval_info GET /w/{workspace}/jobs_u/flow/approval_info/{job_id} get approval info for a suspended flow/WAC job
JobApi get_completed_count GET /w/{workspace}/jobs/completed/count get completed count
JobApi get_completed_job GET /w/{workspace}/jobs_u/completed/get/{id} get completed job
JobApi get_completed_job_logs_tail GET /w/{workspace}/jobs_u/get_completed_logs_tail/{id} get completed job logs tail
JobApi get_completed_job_result GET /w/{workspace}/jobs_u/completed/get_result/{id} get completed job result
JobApi get_completed_job_result_maybe GET /w/{workspace}/jobs_u/completed/get_result_maybe/{id} get completed job result if job is completed
JobApi get_completed_job_timing GET /w/{workspace}/jobs_u/completed/get_timing/{id} get completed job timing
JobApi get_db_clock GET /jobs/db_clock get db clock
JobApi get_flow_all_logs GET /w/{workspace}/jobs_u/get_flow_all_logs/{id} get all logs for a flow job
JobApi get_flow_all_logs_structured GET /w/{workspace}/jobs_u/get_flow_all_logs_structured/{id} get all logs for a flow job in a structured format
JobApi get_flow_debug_info GET /w/{workspace}/jobs_u/get_flow_debug_info/{id} get flow debug info
JobApi get_flow_user_state GET /w/{workspace}/jobs/flow/user_states/{id}/{key} get flow user state at a given key
JobApi get_job GET /w/{workspace}/jobs_u/get/{id} get job
JobApi get_job_args GET /w/{workspace}/jobs_u/get_args/{id} get job args
JobApi get_job_logs GET /w/{workspace}/jobs_u/get_logs/{id} get job logs
JobApi get_job_otel_traces GET /w/{workspace}/jobs/get_otel_traces/{id} get OpenTelemetry traces for a job
JobApi get_job_updates GET /w/{workspace}/jobs_u/getupdate/{id} get job updates
JobApi get_job_updates_sse GET /w/{workspace}/jobs_u/getupdate_sse/{id} get job updates via server-sent events
JobApi get_job_view_token GET /w/{workspace}/jobs/job_view_token/{id} mint a read-only share token for a job
JobApi get_log_file_from_store GET /w/{workspace}/jobs_u/get_log_file/{path} get log file from object store
JobApi get_queue_count GET /w/{workspace}/jobs/queue/count get queue count
JobApi get_queue_position GET /w/{workspace}/jobs/queue/position/{scheduled_for} get queue position for a job
JobApi get_resume_urls GET /w/{workspace}/jobs/resume_urls/{id}/{resume_id} get resume urls given a job_id, resume_id and a nonce to resume a flow
JobApi get_root_job_id GET /w/{workspace}/jobs_u/get_root_job_id/{id} get root job id
JobApi get_scheduled_for GET /w/{workspace}/jobs/queue/scheduled_for/{id} get scheduled for timestamp for a job
JobApi get_slack_approval_payload GET /w/{workspace}/jobs/slack_approval/{id} generate interactive slack approval for suspended job
JobApi get_started_at_by_ids POST /w/{workspace}/jobs_u/queue/get_started_at_by_ids get started at by ids
JobApi get_suspended_job_flow GET /w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature} get parent flow job of suspended job
JobApi get_teams_approval_payload GET /w/{workspace}/jobs/teams_approval/{id} generate interactive teams approval for suspended job
JobApi import_completed_jobs POST /w/{workspace}/jobs/completed/import import completed jobs from backup/migration
JobApi import_queued_jobs POST /w/{workspace}/jobs/queue/import import queued jobs from backup/migration
JobApi list_asset_dispatch_edges GET /w/{workspace}/jobs/asset_dispatch_edges list asset-cascade producer→child job edges for a folder
JobApi list_completed_jobs GET /w/{workspace}/jobs/completed/list list all completed jobs
JobApi list_dispatch_events GET /w/{workspace}/jobs_u/dispatch_events/{id} list asset-trigger dispatch events for a producer job
JobApi list_extended_jobs GET /w/{workspace}/concurrency_groups/list_jobs Get intervals of job runtime concurrency
JobApi list_filtered_jobs_uuids GET /w/{workspace}/jobs/list_filtered_uuids get the ids of all jobs matching the given filters
JobApi list_filtered_queue_uuids GET /w/{workspace}/jobs/queue/list_filtered_uuids get the ids of all queued jobs matching the given filters
JobApi list_jobs GET /w/{workspace}/jobs/list list all jobs
JobApi list_queue GET /w/{workspace}/jobs/queue/list list all queued jobs
JobApi list_selected_job_groups POST /w/{workspace}/jobs/list_selected_job_groups list selected jobs script/flow schemas grouped by (kind, path)
JobApi restart_flow_at_step POST /w/{workspace}/jobs/restart/f/{id} restart a completed flow at a given step
JobApi result_by_id GET /w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id} get job result by id
JobApi resume_suspended POST /w/{workspace}/jobs_u/flow/resume_suspended/{job_id} resume or cancel a suspended flow/WAC job
JobApi resume_suspended_flow_as_owner POST /w/{workspace}/jobs/flow/resume/{id} resume a job for a suspended flow as an owner
JobApi resume_suspended_job_get GET /w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature} resume a job for a suspended flow
JobApi resume_suspended_job_post POST /w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature} resume a job for a suspended flow
JobApi run_and_stream_flow_by_path POST /w/{workspace}/jobs/run_and_stream/f/{path} run flow by path and stream updates via SSE
JobApi run_and_stream_flow_by_path_get GET /w/{workspace}/jobs/run_and_stream/f/{path} run flow by path with GET and stream updates via SSE
JobApi run_and_stream_flow_by_version POST /w/{workspace}/jobs/run_and_stream/fv/{version} run flow by version and stream updates via SSE
JobApi run_and_stream_flow_by_version_get GET /w/{workspace}/jobs/run_and_stream/fv/{version} run flow by version with GET and stream updates via SSE
JobApi run_and_stream_script_by_hash POST /w/{workspace}/jobs/run_and_stream/h/{hash} run script by hash and stream updates via SSE
JobApi run_and_stream_script_by_hash_get GET /w/{workspace}/jobs/run_and_stream/h/{hash} run script by hash with GET and stream updates via SSE
JobApi run_and_stream_script_by_path POST /w/{workspace}/jobs/run_and_stream/p/{path} run script by path and stream updates via SSE
JobApi run_and_stream_script_by_path_get GET /w/{workspace}/jobs/run_and_stream/p/{path} run script by path with GET and stream updates via SSE
JobApi run_code_workflow_task POST /w/{workspace}/jobs/workflow_as_code/{job_id}/{entrypoint} run code-workflow task
JobApi run_dynamic_select POST /w/{workspace}/jobs/run/dynamic_select run dynamic select helper function
JobApi run_flow_by_path POST /w/{workspace}/jobs/run/f/{path} run flow by path
JobApi run_flow_by_version POST /w/{workspace}/jobs/run/fv/{version} run flow by version
JobApi run_flow_dependencies_async POST /w/{workspace}/jobs/run/flow_dependencies_async queue a one-off flow dependencies job and return the job uuid
JobApi run_flow_preview POST /w/{workspace}/jobs/run/preview_flow run flow preview
JobApi run_flow_preview_and_wait_result POST /w/{workspace}/jobs/run_wait_result/preview_flow run flow preview and wait for result
JobApi run_raw_script_dependencies POST /w/{workspace}/jobs/run/dependencies run a one-off dependencies job
JobApi run_raw_script_dependencies_async POST /w/{workspace}/jobs/run/dependencies_async queue a one-off dependencies job and return the job uuid
JobApi run_script_by_hash POST /w/{workspace}/jobs/run/h/{hash} run script by hash
JobApi run_script_by_hash_inline POST /w/{workspace}/jobs/run_inline/h/{hash} run script by hash without starting a new job
JobApi run_script_by_path POST /w/{workspace}/jobs/run/p/{path} run script by path
JobApi run_script_by_path_inline POST /w/{workspace}/jobs/run_inline/p/{path} run script by path without starting a new job
JobApi run_script_preview POST /w/{workspace}/jobs/run/preview run script preview
JobApi run_script_preview_and_wait_result POST /w/{workspace}/jobs/run_wait_result/preview run script preview and wait for result
JobApi run_script_preview_inline POST /w/{workspace}/jobs/run_inline/preview run script preview without starting a new job
JobApi run_wait_result_flow_by_path POST /w/{workspace}/jobs/run_wait_result/f/{path} run flow by path and wait until completion
JobApi run_wait_result_flow_by_version POST /w/{workspace}/jobs/run_wait_result/fv/{version} run flow by version and wait until completion
JobApi run_wait_result_flow_by_version_get GET /w/{workspace}/jobs/run_wait_result/fv/{version} run flow by version with GET and wait until completion
JobApi run_wait_result_script_by_path POST /w/{workspace}/jobs/run_wait_result/p/{path} run script by path
JobApi run_wait_result_script_by_path_get GET /w/{workspace}/jobs/run_wait_result/p/{path} run script by path with get
JobApi set_flow_user_state POST /w/{workspace}/jobs/flow/user_states/{id}/{key} set flow user state at a given key
KafkaTriggerApi commit_kafka_offsets POST /w/{workspace}/kafka_triggers/commit_offsets/{path} commit kafka offsets for a specific trigger
KafkaTriggerApi create_kafka_trigger POST /w/{workspace}/kafka_triggers/create create kafka trigger
KafkaTriggerApi delete_kafka_trigger DELETE /w/{workspace}/kafka_triggers/delete/{path} delete kafka trigger
KafkaTriggerApi exists_kafka_trigger GET /w/{workspace}/kafka_triggers/exists/{path} does kafka trigger exists
KafkaTriggerApi get_kafka_trigger GET /w/{workspace}/kafka_triggers/get/{path} get kafka trigger
KafkaTriggerApi list_kafka_triggers GET /w/{workspace}/kafka_triggers/list list kafka triggers
KafkaTriggerApi reset_kafka_offsets POST /w/{workspace}/kafka_triggers/reset_offsets/{path} reset kafka trigger offsets to earliest
KafkaTriggerApi set_kafka_trigger_mode POST /w/{workspace}/kafka_triggers/setmode/{path} set enabled kafka trigger
KafkaTriggerApi test_kafka_connection POST /w/{workspace}/kafka_triggers/test test kafka connection
KafkaTriggerApi update_kafka_trigger POST /w/{workspace}/kafka_triggers/update/{path} update kafka trigger
McpApi list_mcp_tools GET /mcp/w/{workspace}/list_tools list available MCP tools
McpOauthApi discover_mcp_o_auth POST /mcp/oauth/discover discover MCP server OAuth metadata
McpOauthApi mcp_o_auth_callback GET /mcp/oauth/callback MCP OAuth callback
McpOauthApi start_mcp_o_auth_popup GET /mcp/oauth/start start MCP OAuth popup flow
MetricsApi get_job_metrics POST /w/{workspace}/job_metrics/get/{id} get job metrics
MetricsApi get_job_progress GET /w/{workspace}/job_metrics/get_progress/{id} get job progress
MetricsApi set_job_progress POST /w/{workspace}/job_metrics/set_progress/{id} set job metrics
MqttTriggerApi create_mqtt_trigger POST /w/{workspace}/mqtt_triggers/create create mqtt trigger
MqttTriggerApi delete_mqtt_trigger DELETE /w/{workspace}/mqtt_triggers/delete/{path} delete mqtt trigger
MqttTriggerApi exists_mqtt_trigger GET /w/{workspace}/mqtt_triggers/exists/{path} does mqtt trigger exists
MqttTriggerApi get_mqtt_trigger GET /w/{workspace}/mqtt_triggers/get/{path} get mqtt trigger
MqttTriggerApi list_mqtt_triggers GET /w/{workspace}/mqtt_triggers/list list mqtt triggers
MqttTriggerApi set_mqtt_trigger_mode POST /w/{workspace}/mqtt_triggers/setmode/{path} set enabled mqtt trigger
MqttTriggerApi test_mqtt_connection POST /w/{workspace}/mqtt_triggers/test test mqtt connection
MqttTriggerApi update_mqtt_trigger POST /w/{workspace}/mqtt_triggers/update/{path} update mqtt trigger
NativeTriggerApi create_native_trigger POST /w/{workspace}/native_triggers/{service_name}/create create native trigger
NativeTriggerApi delete_native_trigger DELETE /w/{workspace}/native_triggers/{service_name}/delete/{external_id} delete native trigger
NativeTriggerApi exists_native_trigger GET /w/{workspace}/native_triggers/{service_name}/exists/{external_id} check if native trigger exists
NativeTriggerApi get_native_trigger GET /w/{workspace}/native_triggers/{service_name}/get/{external_id} get native trigger
NativeTriggerApi list_github_repos GET /w/{workspace}/native_triggers/github/repos list GitHub repositories accessible to the user
NativeTriggerApi list_google_calendars GET /w/{workspace}/native_triggers/google/calendars list Google Calendars for the authenticated user
NativeTriggerApi list_google_drive_files GET /w/{workspace}/native_triggers/google/drive/files list or search Google Drive files
NativeTriggerApi list_google_shared_drives GET /w/{workspace}/native_triggers/google/drive/shared_drives list shared drives accessible to the user
NativeTriggerApi list_native_triggers GET /w/{workspace}/native_triggers/{service_name}/list list native triggers
NativeTriggerApi list_next_cloud_events GET /w/{workspace}/native_triggers/nextcloud/events list available NextCloud events
NativeTriggerApi native_trigger_webhook POST /native_triggers/{service_name}/w/{workspace_id}/webhook/{internal_id} receive webhook from external native trigger service
NativeTriggerApi sync_native_triggers POST /w/{workspace}/native_triggers/{service_name}/sync sync native triggers with external service
NativeTriggerApi update_native_trigger POST /w/{workspace}/native_triggers/{service_name}/update/{external_id} update native trigger
NatsTriggerApi create_nats_trigger POST /w/{workspace}/nats_triggers/create create nats trigger
NatsTriggerApi delete_nats_trigger DELETE /w/{workspace}/nats_triggers/delete/{path} delete nats trigger
NatsTriggerApi exists_nats_trigger GET /w/{workspace}/nats_triggers/exists/{path} does nats trigger exists
NatsTriggerApi get_nats_trigger GET /w/{workspace}/nats_triggers/get/{path} get nats trigger
NatsTriggerApi list_nats_triggers GET /w/{workspace}/nats_triggers/list list nats triggers
NatsTriggerApi set_nats_trigger_mode POST /w/{workspace}/nats_triggers/setmode/{path} set enabled nats trigger
NatsTriggerApi test_nats_connection POST /w/{workspace}/nats_triggers/test test NATS connection
NatsTriggerApi update_nats_trigger POST /w/{workspace}/nats_triggers/update/{path} update nats trigger
NpmProxyApi get_npm_package_file GET /w/{workspace}/npm_proxy/file/{package}/{version}/{filepath} get specific file from npm package in private registry
NpmProxyApi get_npm_package_filetree GET /w/{workspace}/npm_proxy/filetree/{package}/{version} get npm package file tree from private registry
NpmProxyApi get_npm_package_metadata GET /w/{workspace}/npm_proxy/metadata/{package} get npm package metadata from private registry
NpmProxyApi resolve_npm_package_version GET /w/{workspace}/npm_proxy/resolve/{package} resolve npm package version from private registry
OauthApi connect_callback POST /oauth/connect_callback/{client_name} connect callback
OauthApi connect_client_credentials POST /w/{workspace}/oauth/connect_client_credentials/{client} connect OAuth using client credentials
OauthApi connect_slack_callback POST /w/{workspace}/oauth/connect_slack_callback connect slack callback
OauthApi connect_slack_callback_instance POST /oauth/connect_slack_callback connect slack callback instance
OauthApi connect_slack_instance POST /oauth/connect_slack_instance connect slack instance (non-interactive; pre-minted bot token)
OauthApi create_account POST /w/{workspace}/oauth/create_account create OAuth account
OauthApi disconnect_account POST /w/{workspace}/oauth/disconnect/{id} disconnect account
OauthApi disconnect_slack POST /w/{workspace}/oauth/disconnect_slack disconnect slack
OauthApi disconnect_teams POST /w/{workspace}/oauth/disconnect_teams disconnect teams
OauthApi get_o_auth_connect GET /oauth/get_connect/{client} get oauth connect
OauthApi list_o_auth_connects GET /oauth/list_connects list oauth connects
OauthApi list_o_auth_logins GET /oauth/list_logins list oauth logins
OauthApi refresh_token POST /w/{workspace}/oauth/refresh_token/{id} refresh token
OidcApi get_oidc_token POST /w/{workspace}/oidc/token/{audience} get OIDC token (ee only)
OpenapiApi download_openapi_spec POST /w/{workspace}/openapi/download Download the OpenAPI v3.1 spec as a file
OpenapiApi generate_openapi_spec POST /w/{workspace}/openapi/generate generate openapi spec from http routes/webhook
PathAutocompleteApi list_path_autocomplete_paths GET /w/{workspace}/path_autocomplete/list_paths list all paths in a workspace for client-side autocomplete
PostgresTriggerApi create_postgres_publication POST /w/{workspace}/postgres_triggers/publication/create/{publication}/{path} create publication for postgres
PostgresTriggerApi create_postgres_replication_slot POST /w/{workspace}/postgres_triggers/slot/create/{path} create replication slot for postgres
PostgresTriggerApi create_postgres_trigger POST /w/{workspace}/postgres_triggers/create create postgres trigger
PostgresTriggerApi create_template_script POST /w/{workspace}/postgres_triggers/create_template_script create template script
PostgresTriggerApi delete_postgres_publication DELETE /w/{workspace}/postgres_triggers/publication/delete/{publication}/{path} delete postgres publication
PostgresTriggerApi delete_postgres_replication_slot DELETE /w/{workspace}/postgres_triggers/slot/delete/{path} delete postgres replication slot
PostgresTriggerApi delete_postgres_trigger DELETE /w/{workspace}/postgres_triggers/delete/{path} delete postgres trigger
PostgresTriggerApi exists_postgres_trigger GET /w/{workspace}/postgres_triggers/exists/{path} does postgres trigger exists
PostgresTriggerApi get_postgres_publication GET /w/{workspace}/postgres_triggers/publication/get/{publication}/{path} get postgres publication
PostgresTriggerApi get_postgres_trigger GET /w/{workspace}/postgres_triggers/get/{path} get postgres trigger
PostgresTriggerApi get_postgres_version GET /w/{workspace}/postgres_triggers/postgres/version/{path} get postgres version
PostgresTriggerApi get_template_script GET /w/{workspace}/postgres_triggers/get_template_script/{id} get template script
PostgresTriggerApi is_valid_postgres_configuration GET /w/{workspace}/postgres_triggers/is_valid_postgres_configuration/{path} check if postgres configuration is set to logical
PostgresTriggerApi list_postgres_publication GET /w/{workspace}/postgres_triggers/publication/list/{path} list postgres publication
PostgresTriggerApi list_postgres_replication_slot GET /w/{workspace}/postgres_triggers/slot/list/{path} list postgres replication slot
PostgresTriggerApi list_postgres_triggers GET /w/{workspace}/postgres_triggers/list list postgres triggers
PostgresTriggerApi set_postgres_trigger_mode POST /w/{workspace}/postgres_triggers/setmode/{path} set enabled postgres trigger
PostgresTriggerApi test_postgres_connection POST /w/{workspace}/postgres_triggers/test test postgres connection
PostgresTriggerApi update_postgres_publication POST /w/{workspace}/postgres_triggers/publication/update/{publication}/{path} update publication for postgres
PostgresTriggerApi update_postgres_trigger POST /w/{workspace}/postgres_triggers/update/{path} update postgres trigger
RawAppApi list_raw_apps GET /w/{workspace}/raw_apps/list list all raw apps
ResourceApi create_resource POST /w/{workspace}/resources/create create resource
ResourceApi create_resource_type POST /w/{workspace}/resources/type/create create resource_type
ResourceApi delete_resource DELETE /w/{workspace}/resources/delete/{path} delete resource
ResourceApi delete_resource_type DELETE /w/{workspace}/resources/type/delete/{path} delete resource_type
ResourceApi delete_resources_bulk DELETE /w/{workspace}/resources/delete_bulk delete resources in bulk
ResourceApi exists_resource GET /w/{workspace}/resources/exists/{path} does resource exists
ResourceApi exists_resource_type GET /w/{workspace}/resources/type/exists/{path} does resource_type exists
ResourceApi file_resource_type_to_file_ext_map GET /w/{workspace}/resources/file_resource_type_to_file_ext_map get map from resource type to format extension
ResourceApi get_git_commit_hash GET /w/{workspace}/resources/git_commit_hash/{path} get git repository latest commit hash
ResourceApi get_mcp_tools GET /w/{workspace}/resources/mcp_tools/{path} get MCP tools from resource
ResourceApi get_resource GET /w/{workspace}/resources/get/{path} get resource
ResourceApi get_resource_type GET /w/{workspace}/resources/type/get/{path} get resource_type
ResourceApi get_resource_value GET /w/{workspace}/resources/get_value/{path} get resource value
ResourceApi get_resource_value_interpolated GET /w/{workspace}/resources/get_value_interpolated/{path} get resource interpolated (variables and resources are fully unrolled)
ResourceApi list_resource GET /w/{workspace}/resources/list list resources
ResourceApi list_resource_names GET /w/{workspace}/resources/list_names/{name} list resource names
ResourceApi list_resource_type GET /w/{workspace}/resources/type/list list resource_types
ResourceApi list_resource_type_names GET /w/{workspace}/resources/type/listnames list resource_types names
ResourceApi list_search_resource GET /w/{workspace}/resources/list_search list resources for search
ResourceApi query_resource_types GET /w/{workspace}/embeddings/query_resource_types query resource types by similarity
ResourceApi update_resource POST /w/{workspace}/resources/update/{path} update resource
ResourceApi update_resource_type POST /w/{workspace}/resources/type/update/{path} update resource_type
ResourceApi update_resource_value POST /w/{workspace}/resources/update_value/{path} update resource value
ScheduleApi create_schedule POST /w/{workspace}/schedules/create create schedule
ScheduleApi delete_schedule DELETE /w/{workspace}/schedules/delete/{path} delete schedule
ScheduleApi exists_schedule GET /w/{workspace}/schedules/exists/{path} does schedule exists
ScheduleApi get_schedule GET /w/{workspace}/schedules/get/{path} get schedule
ScheduleApi list_schedules GET /w/{workspace}/schedules/list list schedules
ScheduleApi list_schedules_with_jobs GET /w/{workspace}/schedules/list_with_jobs list schedules with last 20 jobs
ScheduleApi preview_schedule POST /schedules/preview preview schedule
ScheduleApi set_default_error_or_recovery_handler POST /w/{workspace}/schedules/setdefaulthandler Set default error or recoevery handler
ScheduleApi set_schedule_enabled POST /w/{workspace}/schedules/setenabled/{path} set enabled schedule
ScheduleApi update_schedule POST /w/{workspace}/schedules/update/{path} update schedule
ScriptApi archive_script_by_hash POST /w/{workspace}/scripts/archive/h/{hash} archive script by hash
ScriptApi archive_script_by_path POST /w/{workspace}/scripts/archive/p/{path} archive script by path
ScriptApi create_script POST /w/{workspace}/scripts/create create script
ScriptApi delete_script_by_hash POST /w/{workspace}/scripts/delete/h/{hash} delete script by hash (erase content but keep hash, require admin)
ScriptApi delete_script_by_path POST /w/{workspace}/scripts/delete/p/{path} delete script at a given path (require admin)
ScriptApi delete_scripts_bulk DELETE /w/{workspace}/scripts/delete_bulk delete scripts in bulk
ScriptApi diff_raw_scripts_with_deployed POST /w/{workspace}/scripts/raw_temp/diff diff local script hashes against deployed versions
ScriptApi exists_script_by_path GET /w/{workspace}/scripts/exists/p/{path} exists script by path
ScriptApi get_ci_test_results GET /w/{workspace}/scripts/ci_test_results/{kind}/{path} get CI test results for a script, flow, or resource
ScriptApi get_ci_test_results_batch POST /w/{workspace}/scripts/ci_test_results_batch get CI test results for multiple items
ScriptApi get_hub_script_by_path GET /scripts/hub/get_full/{path} get full hub script by path
ScriptApi get_hub_script_content_by_path GET /scripts/hub/get/{path} get hub script content by path
ScriptApi get_script_by_hash GET /w/{workspace}/scripts/get/h/{hash} get script by hash
ScriptApi get_script_by_path GET /w/{workspace}/scripts/get/p/{path} get script by path
ScriptApi get_script_deployment_status GET /w/{workspace}/scripts/deployment_status/h/{hash} get script deployment status
ScriptApi get_script_history_by_path GET /w/{workspace}/scripts/history/p/{path} get history of a script by path
ScriptApi get_script_latest_version GET /w/{workspace}/scripts/get_latest_version/{path} get scripts's latest version (hash)
ScriptApi get_top_hub_scripts GET /scripts/hub/top get top hub scripts
ScriptApi get_triggers_count_of_script GET /w/{workspace}/scripts/get_triggers_count/{path} get triggers count of script
ScriptApi list_dedicated_with_deps GET /w/{workspace}/scripts/list_dedicated_with_deps list dedicated worker scripts with workspace dependency annotations
ScriptApi list_script_paths GET /w/{workspace}/scripts/list_paths list all scripts paths
ScriptApi 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
ScriptApi list_scripts GET /w/{workspace}/scripts/list list all scripts
ScriptApi list_search_script GET /w/{workspace}/scripts/list_search list scripts for search
ScriptApi list_tokens_of_script GET /w/{workspace}/scripts/list_tokens/{path} get tokens with script scope
ScriptApi pick_hub_script_by_path GET /scripts/hub/pick/{path} record hub script pick
ScriptApi query_hub_scripts GET /embeddings/query_hub_scripts query hub scripts by similarity
ScriptApi raw_script_by_hash GET /w/{workspace}/scripts/raw/h/{path} raw script by hash
ScriptApi raw_script_by_path GET /w/{workspace}/scripts/raw/p/{path} raw script by path
ScriptApi 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)
ScriptApi store_raw_script_temp POST /w/{workspace}/scripts/raw_temp/store store raw script content temporarily for CLI lock generation
ScriptApi 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
ScriptApi update_script_history POST /w/{workspace}/scripts/history_update/h/{hash}/p/{path} update history of a script
ServiceLogsApi get_log_file GET /service_logs/get_log_file/{path} get log file by path
ServiceLogsApi list_log_files GET /service_logs/list_files list log files ordered by timestamp
SettingApi acknowledge_all_critical_alerts POST /settings/critical_alerts/acknowledge_all Acknowledge all unacknowledged critical alerts
SettingApi acknowledge_critical_alert POST /settings/critical_alerts/{id}/acknowledge Acknowledge a critical alert
SettingApi compute_object_storage_usage POST /settings/object_storage_usage start a background computation of object storage usage by top-level folder
SettingApi create_customer_portal_session POST /settings/customer_portal create customer portal session
SettingApi drop_custom_instance_db POST /settings/drop_custom_instance_pg_database/{name} Drops a custom instance database (superadmin only, irreversible)
SettingApi get_audit_logs_s3_status GET /settings/audit_logs_s3_status get status of the audit-log object-store export cursor
SettingApi get_critical_alerts GET /settings/critical_alerts Get all critical alerts
SettingApi get_global GET /settings/global/{key} get global settings
SettingApi get_instance_config GET /settings/instance_config get full instance config (global settings + worker configs)
SettingApi get_instance_hash GET /settings/instance_hash per-instance binding hash for offline license issuance
SettingApi get_jwks GET /.well-known/jwks.json get JWKS for Vault JWT authentication
SettingApi get_latest_key_renewal_attempt GET /settings/latest_key_renewal_attempt get latest key renewal attempt
SettingApi get_local GET /settings/local get local settings
SettingApi get_log_cleanup_status GET /settings/log_cleanup_status get status of the manual log cleanup task
SettingApi get_min_keep_alive_version GET /min_keep_alive_version get minimum worker versions required to stay alive
SettingApi get_object_storage_usage GET /settings/object_storage_usage get current or last object storage usage computation (null if never run)
SettingApi get_offline_license_status GET /settings/offline_license_status get cap-usage status for the currently-loaded offline license
SettingApi get_ruff_config GET /settings_u/ruff_config get instance ruff config (unauthenticated)
SettingApi get_secondary_storage_names GET /w/{workspace}/workspaces/get_secondary_storage_names get secondary storage names
SettingApi get_stats GET /settings/get_stats get telemetry stats with HMAC signature (EE only)
SettingApi list_custom_instance_dbs POST /settings/list_custom_instance_pg_databases Returns the set-up statuses of custom instance pg databases
SettingApi list_global_settings GET /settings/list_global list global settings
SettingApi migrate_secrets_from_aws_sm POST /settings/migrate_secrets_from_aws_sm migrate secrets from AWS Secrets Manager to database
SettingApi migrate_secrets_from_azure_kv POST /settings/migrate_secrets_from_azure_kv migrate secrets from Azure Key Vault to database
SettingApi migrate_secrets_to_aws_sm POST /settings/migrate_secrets_to_aws_sm migrate secrets from database to AWS Secrets Manager
SettingApi migrate_secrets_to_azure_kv POST /settings/migrate_secrets_to_azure_kv migrate secrets from database to Azure Key Vault
SettingApi migrate_secrets_to_database POST /settings/migrate_secrets_to_database migrate secrets from HashiCorp Vault to database
SettingApi migrate_secrets_to_vault POST /settings/migrate_secrets_to_vault migrate secrets from database to HashiCorp Vault
SettingApi refresh_custom_instance_user_pwd POST /settings/refresh_custom_instance_user_pwd Refreshes the password for the custom_instance_user
SettingApi renew_license_key POST /settings/renew_license_key renew license key
SettingApi restart_worker_group POST /settings/restart_worker_group/{worker_group} restart worker group
SettingApi run_log_cleanup POST /settings/run_log_cleanup start a manual cleanup of expired logs from object storage
SettingApi send_stats POST /settings/send_stats send stats
SettingApi set_global POST /settings/global/{key} post global settings
SettingApi set_instance_config PUT /settings/instance_config update instance config (bulk upsert, no deletes). Empty or missing global_settings/worker_configs are skipped.
SettingApi set_public_app_rate_limit POST /w/{workspace}/workspaces/public_app_rate_limit Set public app rate limit for this workspace
SettingApi setup_custom_instance_db POST /settings/setup_custom_instance_pg_database/{name} Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user
SettingApi test_aws_sm_backend POST /settings/test_aws_sm_backend test connection to AWS Secrets Manager
SettingApi test_azure_kv_backend POST /settings/test_azure_kv_backend test Azure Key Vault connection
SettingApi test_critical_channels POST /settings/test_critical_channels test critical channels
SettingApi test_license_key POST /settings/test_license_key test license key
SettingApi test_metadata POST /saml/test_metadata test metadata
SettingApi test_object_storage_config POST /settings/test_object_storage_config test object storage config
SettingApi test_secret_backend POST /settings/test_secret_backend test secret backend connection (HashiCorp Vault)
SettingApi test_smtp POST /settings/test_smtp test smtp
SettingApi workspace_acknowledge_all_critical_alerts POST /w/{workspace}/workspaces/critical_alerts/acknowledge_all Acknowledge all unacknowledged critical alerts for this workspace
SettingApi workspace_acknowledge_critical_alert POST /w/{workspace}/workspaces/critical_alerts/{id}/acknowledge Acknowledge a critical alert for this workspace
SettingApi workspace_get_critical_alerts GET /w/{workspace}/workspaces/critical_alerts Get all critical alerts for this workspace
SettingApi workspace_mute_critical_alerts_ui POST /w/{workspace}/workspaces/critical_alerts/mute Mute critical alert UI for this workspace
SettingsApi backend_uptodate GET /uptodate is backend up to date
SettingsApi backend_version GET /version get backend version
SettingsApi get_license_id GET /ee_license get license id
SettingsApi get_open_api_yaml GET /openapi.yaml get openapi yaml spec
SqsTriggerApi create_sqs_trigger POST /w/{workspace}/sqs_triggers/create create sqs trigger
SqsTriggerApi delete_sqs_trigger DELETE /w/{workspace}/sqs_triggers/delete/{path} delete sqs trigger
SqsTriggerApi exists_sqs_trigger GET /w/{workspace}/sqs_triggers/exists/{path} does sqs trigger exists
SqsTriggerApi get_sqs_trigger GET /w/{workspace}/sqs_triggers/get/{path} get sqs trigger
SqsTriggerApi list_sqs_triggers GET /w/{workspace}/sqs_triggers/list list sqs triggers
SqsTriggerApi set_sqs_trigger_mode POST /w/{workspace}/sqs_triggers/setmode/{path} set enabled sqs trigger
SqsTriggerApi test_sqs_connection POST /w/{workspace}/sqs_triggers/test test sqs connection
SqsTriggerApi update_sqs_trigger POST /w/{workspace}/sqs_triggers/update/{path} update sqs trigger
TeamsApi send_message_to_conversation POST /teams/activities send update to Microsoft Teams activity
TokenApi list_available_scopes GET /tokens/list/scopes list of available scopes
TriggerApi cancel_suspended_trigger_jobs POST /w/{workspace}/trigger/{trigger_kind}/cancel_suspended_trigger_jobs/{trigger_path} cancel all suspended jobs for a specific trigger
TriggerApi resume_suspended_trigger_jobs POST /w/{workspace}/trigger/{trigger_kind}/resume_suspended_trigger_jobs/{trigger_path} resume all suspended jobs for a specific trigger
UserApi accept_invite POST /users/accept_invite accept invite to workspace
UserApi convert_user_to_group POST /w/{workspace}/users/convert_to_group/{username} convert manual user to group user (require admin privilege)
UserApi create_token POST /users/tokens/create create token
UserApi create_token_impersonate POST /users/tokens/impersonate create token to impersonate a user (require superadmin)
UserApi create_user_globally POST /users/create create user
UserApi decline_invite POST /users/decline_invite decline invite to workspace
UserApi delete_token DELETE /users/tokens/delete/{token_prefix} delete token
UserApi delete_user DELETE /w/{workspace}/users/delete/{username} delete user (require admin privilege)
UserApi exists_email GET /users/exists/{email} exists email
UserApi exit_impersonation POST /w/{workspace}/users/exit_impersonation exit service account impersonation
UserApi get_current_email GET /users/email get current user email (if logged in)
UserApi get_runnable GET /users/all_runnables get all runnables in every workspace
UserApi get_tutorial_progress GET /users/tutorial_progress get tutorial progress
UserApi get_usage GET /users/usage get current usage outside of premium workspaces
UserApi get_user GET /w/{workspace}/users/get/{username} get user (require admin privilege)
UserApi global_offboard_preview GET /users/offboard_preview/{email} preview global offboarding for a user across all workspaces (require super admin)
UserApi global_user_delete DELETE /users/delete/{email} global delete user (require super admin)
UserApi global_user_rename POST /users/rename/{email} global rename user (require super admin)
UserApi global_user_update POST /users/update/{email} global update user (require super admin)
UserApi global_username_info GET /users/username_info/{email} global username info (require super admin)
UserApi global_users_export GET /users/export global export users (require super admin and EE)
UserApi global_users_overwrite POST /users/overwrite global overwrite users (require super admin and EE)
UserApi global_whoami GET /users/whoami get current global whoami (if logged in)
UserApi impersonate_service_account POST /w/{workspace}/users/impersonate_service_account impersonate a service account
UserApi is_owner_of_path GET /w/{workspace}/users/is_owner/{path} is owner of path
UserApi is_password_login_disabled GET /auth/is_password_login_disabled check if password login is disabled instance-wide
UserApi is_smtp_configured GET /auth/is_smtp_configured check if SMTP is configured for password reset
UserApi leave_instance POST /users/leave_instance leave instance
UserApi list_ext_jwt_tokens GET /users/ext_jwt_tokens list external JWT tokens (ee only)
UserApi list_tokens GET /users/tokens/list list token
UserApi list_usernames GET /w/{workspace}/users/list_usernames list usernames
UserApi list_users GET /w/{workspace}/users/list list users
UserApi list_users_as_super_admin GET /users/list_as_super_admin list all users as super admin (require to be super amdin)
UserApi list_users_usage GET /w/{workspace}/users/list_usage list users usage
UserApi list_workspace_invites GET /users/list_invites list all workspace invites
UserApi login POST /auth/login login with password
UserApi login_with_oauth POST /oauth/login_callback/{client_name} login with oauth authorization flow
UserApi logout POST /auth/logout logout
UserApi offboard_global_user POST /users/offboard/{email} offboard a user globally (reassign objects across workspaces, optionally delete)
UserApi offboard_preview GET /w/{workspace}/users/offboard_preview/{username} preview offboarding for a workspace user (require admin privilege)
UserApi offboard_workspace_user POST /w/{workspace}/users/offboard/{username} offboard a workspace user (reassign objects, optionally delete user)
UserApi refresh_user_token GET /users/refresh_token refresh the current token
UserApi request_password_reset POST /auth/request_password_reset request password reset email
UserApi reset_password POST /auth/reset_password reset password using token
UserApi set_login_type_for_user POST /users/set_login_type/{user} set login type for a specific user (require super admin)
UserApi set_password POST /users/setpassword set password
UserApi set_password_for_user POST /users/set_password_of/{user} set password for a specific user (require super admin)
UserApi submit_onboarding_data POST /users/onboarding Submit user onboarding data
UserApi update_token_label POST /users/tokens/update_label/{token_prefix} update label of an existing token (owner only)
UserApi update_token_scopes POST /users/tokens/update_scopes/{token_prefix} update scopes of an existing token (owner only)
UserApi update_tutorial_progress POST /users/tutorial_progress update tutorial progress
UserApi update_user POST /w/{workspace}/users/update/{username} update user (require admin privilege)
UserApi username_to_email GET /w/{workspace}/users/username_to_email/{username} get email from username
UserApi whoami GET /w/{workspace}/users/whoami whoami
UserApi whois GET /w/{workspace}/users/whois/{username} whois
VariableApi create_variable POST /w/{workspace}/variables/create create variable
VariableApi delete_variable DELETE /w/{workspace}/variables/delete/{path} delete variable
VariableApi delete_variables_bulk DELETE /w/{workspace}/variables/delete_bulk delete variables in bulk
VariableApi encrypt_value POST /w/{workspace}/variables/encrypt encrypt value
VariableApi exists_variable GET /w/{workspace}/variables/exists/{path} does variable exists at path
VariableApi get_variable GET /w/{workspace}/variables/get/{path} get variable
VariableApi get_variable_value GET /w/{workspace}/variables/get_value/{path} get variable value
VariableApi list_contextual_variables GET /w/{workspace}/variables/list_contextual list contextual variables
VariableApi list_variable GET /w/{workspace}/variables/list list variables
VariableApi update_variable POST /w/{workspace}/variables/update/{path} update variable
VolumeApi create_volume POST /w/{workspace}/volumes/create Create a new volume
VolumeApi delete_volume DELETE /w/{workspace}/volumes/delete/{name} Delete a volume (admin only)
VolumeApi get_volume_storage GET /w/{workspace}/volumes/storage Get the volume storage name (secondary storage) or null for primary
VolumeApi list_volumes GET /w/{workspace}/volumes/list List all volumes in the workspace
WebsocketTriggerApi create_websocket_trigger POST /w/{workspace}/websocket_triggers/create create websocket trigger
WebsocketTriggerApi delete_websocket_trigger DELETE /w/{workspace}/websocket_triggers/delete/{path} delete websocket trigger
WebsocketTriggerApi exists_websocket_trigger GET /w/{workspace}/websocket_triggers/exists/{path} does websocket trigger exists
WebsocketTriggerApi get_websocket_trigger GET /w/{workspace}/websocket_triggers/get/{path} get websocket trigger
WebsocketTriggerApi list_websocket_triggers GET /w/{workspace}/websocket_triggers/list list websocket triggers
WebsocketTriggerApi set_websocket_trigger_mode POST /w/{workspace}/websocket_triggers/setmode/{path} set enabled websocket trigger
WebsocketTriggerApi test_websocket_connection POST /w/{workspace}/websocket_triggers/test test websocket connection
WebsocketTriggerApi update_websocket_trigger POST /w/{workspace}/websocket_triggers/update/{path} update websocket trigger
WorkerApi exists_workers_with_tags GET /workers/exists_workers_with_tags exists workers with tags
WorkerApi ge_default_tags GET /workers/get_default_tags get all instance default tags
WorkerApi get_counts_of_jobs_waiting_per_tag GET /workers/queue_counts get counts of jobs waiting for an executor per tag
WorkerApi get_counts_of_running_jobs_per_tag GET /workers/queue_running_counts get counts of currently running jobs per tag
WorkerApi get_custom_tags GET /workers/custom_tags get all instance custom tags (tags are used to dispatch jobs to different worker groups)
WorkerApi get_custom_tags_for_workspace GET /w/{workspace}/workers/custom_tags get custom tags available for this workspace
WorkerApi get_queue_metrics GET /workers/queue_metrics get queue metrics
WorkerApi get_workspace_fairness_events GET /workers/workspace_fairness_events list last 100 workspace-fairness cap/uncap events (cloud-only)
WorkerApi is_default_tags_per_workspace GET /workers/is_default_tags_per_workspace is default tags per workspace
WorkerApi list_workers GET /workers/list list workers
WorkspaceApi add_user POST /w/{workspace}/workspaces/add_user add user to workspace
WorkspaceApi archive_workspace POST /w/{workspace}/workspaces/archive archive workspace
WorkspaceApi cancel_deployment_request POST /w/{workspace}/deployment_request/{id}/cancel cancel an open deployment request
WorkspaceApi change_workspace_color POST /w/{workspace}/workspaces/change_workspace_color change workspace id
WorkspaceApi change_workspace_id POST /w/{workspace}/workspaces/change_workspace_id change workspace id
WorkspaceApi change_workspace_name POST /w/{workspace}/workspaces/change_workspace_name change workspace name
WorkspaceApi close_deployment_request_merged POST /w/{workspace}/deployment_request/{id}/close_merged close a deployment request after a successful merge
WorkspaceApi compare_workspaces GET /w/{workspace}/workspaces/compare/{target_workspace_id} Compare two workspaces
WorkspaceApi connect_slack POST /w/{workspace}/workspaces/connect_slack connect slack (non-interactive; pre-minted bot token)
WorkspaceApi connect_teams POST /w/{workspace}/workspaces/connect_teams connect teams
WorkspaceApi create_deployment_request POST /w/{workspace}/deployment_request create a new deployment request
WorkspaceApi create_deployment_request_comment POST /w/{workspace}/deployment_request/{id}/comment append a comment to an open deployment request
WorkspaceApi create_pg_database POST /w/{workspace}/workspaces/create_pg_database create a new PostgreSQL database for a datatable
WorkspaceApi create_protection_rule POST /w/{workspace}/workspaces/protection_rules create a new protection rule
WorkspaceApi create_service_account POST /w/{workspace}/workspaces/create_service_account create a service account
WorkspaceApi create_workspace POST /workspaces/create create workspace
WorkspaceApi create_workspace_fork POST /w/{workspace}/workspaces/create_fork create forked workspace
WorkspaceApi create_workspace_fork_git_branch POST /w/{workspace}/workspaces/create_workspace_fork_branch create forked workspace branch with git sync
WorkspaceApi delete_ai_skill DELETE /w/{workspace}/ai_skills/delete/{name} delete a workspace AI chat skill (admin only)
WorkspaceApi delete_git_sync_repository DELETE /w/{workspace}/workspaces/delete_git_sync_repository delete individual git sync repository
WorkspaceApi delete_invite POST /w/{workspace}/workspaces/delete_invite delete user invite
WorkspaceApi delete_protection_rule DELETE /w/{workspace}/workspaces/protection_rules/{rule_name} delete a protection rule
WorkspaceApi delete_workspace DELETE /workspaces/delete/{workspace} delete workspace (require super admin)
WorkspaceApi delete_workspace_slack_oauth_config DELETE /w/{workspace}/workspaces/slack_oauth_config delete workspace slack oauth config
WorkspaceApi drop_forked_datatable_databases POST /w/{workspace}/workspaces/drop_forked_datatable_databases drop forked datatable databases
WorkspaceApi edit_auto_invite POST /w/{workspace}/workspaces/edit_auto_invite edit auto invite
WorkspaceApi edit_copilot_config POST /w/{workspace}/workspaces/edit_copilot_config edit copilot config
WorkspaceApi edit_data_table_config POST /w/{workspace}/workspaces/edit_datatable_config edit datatable settings
WorkspaceApi edit_default_scripts POST /w/{workspace}/workspaces/default_scripts edit default scripts for workspace
WorkspaceApi edit_deploy_to POST /w/{workspace}/workspaces/edit_deploy_to edit deploy to
WorkspaceApi edit_ducklake_config POST /w/{workspace}/workspaces/edit_ducklake_config edit ducklake settings
WorkspaceApi edit_error_handler POST /w/{workspace}/workspaces/edit_error_handler edit error handler
WorkspaceApi edit_git_sync_repository POST /w/{workspace}/workspaces/edit_git_sync_repository add or update individual git sync repository
WorkspaceApi edit_instance_groups POST /w/{workspace}/workspaces/edit_instance_groups edit instance groups
WorkspaceApi edit_large_file_storage_config POST /w/{workspace}/workspaces/edit_large_file_storage_config edit large file storage settings
WorkspaceApi edit_slack_command POST /w/{workspace}/workspaces/edit_slack_command edit slack command
WorkspaceApi edit_success_handler POST /w/{workspace}/workspaces/edit_success_handler edit success handler
WorkspaceApi edit_teams_command POST /w/{workspace}/workspaces/edit_teams_command edit teams command
WorkspaceApi edit_webhook POST /w/{workspace}/workspaces/edit_webhook edit webhook
WorkspaceApi edit_workspace_default_app POST /w/{workspace}/workspaces/edit_default_app edit default app for workspace
WorkspaceApi edit_workspace_deploy_ui_settings POST /w/{workspace}/workspaces/edit_deploy_ui_config edit workspace deploy ui settings
WorkspaceApi edit_workspace_git_sync_config POST /w/{workspace}/workspaces/edit_git_sync_config edit workspace git sync settings
WorkspaceApi exists_username POST /workspaces/exists_username exists username
WorkspaceApi exists_workspace POST /workspaces/exists exists workspace
WorkspaceApi export_pg_schema POST /w/{workspace}/workspaces/export_pg_schema export the schema of a PostgreSQL database
WorkspaceApi get_ai_skill GET /w/{workspace}/ai_skills/get/{name} get a workspace AI chat skill including its instructions
WorkspaceApi get_cloud_quotas GET /w/{workspace}/workspaces/cloud_quotas get cloud quota usage and limits for workspace
WorkspaceApi get_copilot_info GET /w/{workspace}/workspaces/get_copilot_info get copilot info
WorkspaceApi get_copilot_settings_state GET /w/{workspace}/workspaces/get_copilot_settings_state get copilot settings state
WorkspaceApi get_data_table_table_schema GET /w/{workspace}/workspaces/get_datatable_table_schema get one Datatable table schema
WorkspaceApi get_datatable_full_schema POST /w/{workspace}/workspaces/get_datatable_full_schema get the full schema of a datatable database as TableEditorValues
WorkspaceApi get_default_scripts GET /w/{workspace}/workspaces/default_scripts get default scripts for workspace
WorkspaceApi get_dependency_map GET /w/{workspace}/workspaces/get_dependency_map get dependency map
WorkspaceApi get_dependents GET /w/{workspace}/workspaces/get_dependents/{imported_path} get dependents of an imported path
WorkspaceApi get_dependents_amounts POST /w/{workspace}/workspaces/get_dependents_amounts get dependents amounts for multiple imported paths
WorkspaceApi get_deploy_to GET /w/{workspace}/workspaces/get_deploy_to get deploy to
WorkspaceApi get_git_sync_enabled GET /w/{workspace}/workspaces/git_sync_enabled Check if git sync is available for this workspace
WorkspaceApi get_github_app_token POST /w/{workspace}/github_app/token get github app token
WorkspaceApi get_imports GET /w/{workspace}/workspaces/get_imports/{importer_path} get script imports for an importer path
WorkspaceApi get_is_premium GET /w/{workspace}/workspaces/is_premium get if workspace is premium
WorkspaceApi get_open_deployment_request GET /w/{workspace}/deployment_request/open get the currently open deployment request for this fork
WorkspaceApi get_premium_info GET /w/{workspace}/workspaces/premium_info get premium info
WorkspaceApi get_public_settings GET /w/{workspace}/workspaces/get_public_settings get public settings
WorkspaceApi get_session_workspace_status POST /workspaces/session_workspace_status get the lifecycle status of workspaces referenced by client-side sessions
WorkspaceApi get_settings GET /w/{workspace}/workspaces/get_settings get settings (admin only)
WorkspaceApi get_shared_ui GET /w/{workspace}/shared_ui/get get the workspace shared UI folder (full content)
WorkspaceApi get_shared_ui_version GET /w/{workspace}/shared_ui/version get the current version of the workspace shared UI folder
WorkspaceApi get_threshold_alert GET /w/{workspace}/workspaces/threshold_alert get threshold alert info
WorkspaceApi get_used_triggers GET /w/{workspace}/workspaces/used_triggers get used triggers
WorkspaceApi get_workspace_as_super_admin GET /w/{workspace}/workspaces/get_as_superadmin get workspace as super admin (require to be super admin)
WorkspaceApi get_workspace_default_app GET /w/{workspace}/workspaces/default_app get default app for workspace
WorkspaceApi get_workspace_encryption_key GET /w/{workspace}/workspaces/encryption_key retrieves the encryption key for this workspace
WorkspaceApi get_workspace_name GET /w/{workspace}/workspaces/get_workspace_name get workspace name
WorkspaceApi get_workspace_slack_oauth_config GET /w/{workspace}/workspaces/slack_oauth_config get workspace slack oauth config
WorkspaceApi get_workspace_usage GET /w/{workspace}/workspaces/usage get usage
WorkspaceApi import_pg_database POST /w/{workspace}/workspaces/import_pg_database import a PostgreSQL database from source to target via pg_dump
WorkspaceApi invite_user POST /w/{workspace}/workspaces/invite_user invite user to workspace
WorkspaceApi is_domain_allowed GET /workspaces/allowed_domain_auto_invite is domain allowed for auto invi
WorkspaceApi leave_workspace POST /w/{workspace}/workspaces/leave leave workspace
WorkspaceApi list_ai_skills GET /w/{workspace}/ai_skills/list list the workspace AI chat skills (name + description only)
WorkspaceApi list_available_teams_channels GET /w/{workspace}/workspaces/available_teams_channels list available channels for a specific team
WorkspaceApi list_available_teams_ids GET /w/{workspace}/workspaces/available_teams_ids list available teams ids
WorkspaceApi list_data_table_schemas GET /w/{workspace}/workspaces/list_datatable_schemas list schemas of all connected Datatables
WorkspaceApi list_data_table_tables GET /w/{workspace}/workspaces/list_datatable_tables list tables of all connected Datatables
WorkspaceApi list_data_tables GET /w/{workspace}/workspaces/list_datatables list Datatables
WorkspaceApi list_deployment_request_eligible_deployers GET /w/{workspace}/deployment_request/eligible_deployers list users eligible to be deployment request assignees
WorkspaceApi list_ducklakes GET /w/{workspace}/workspaces/list_ducklakes list ducklakes
WorkspaceApi list_pending_invites GET /w/{workspace}/workspaces/list_pending_invites list pending invites for a workspace
WorkspaceApi list_protection_rules GET /w/{workspace}/workspaces/protection_rules list all protection rules for a workspace
WorkspaceApi list_shared_ui GET /w/{workspace}/shared_ui/list list paths/sizes of the workspace shared UI folder
WorkspaceApi list_user_workspaces GET /workspaces/users list all workspaces visible to me with user info
WorkspaceApi list_workspaces GET /workspaces/list list all workspaces visible to me
WorkspaceApi list_workspaces_as_super_admin GET /workspaces/list_as_superadmin list all workspaces as super admin (require to be super admin)
WorkspaceApi list_ws_specific GET /w/{workspace}/workspaces/list_ws_specific list all workspace-specific items
WorkspaceApi list_ws_specific_versions GET /w/{workspace}/workspaces/list_ws_specific_versions list workspace ids that have a version of the given item
WorkspaceApi log_ai_chat POST /w/{workspace}/workspaces/log_chat log AI chat message
WorkspaceApi prune_versions POST /w/{workspace}/workspaces/prune_versions prune old versions of scripts, flows, or apps
WorkspaceApi rebuild_dependency_map POST /w/{workspace}/workspaces/rebuild_dependency_map rebuild dependency map
WorkspaceApi reset_diff_tally POST /w/{workspace}/workspaces/reset_diff_tally/{fork_workspace_id} Resets the ahead and behind deployement counter after a deployement
WorkspaceApi run_slack_message_test_job POST /w/{workspace}/workspaces/run_slack_message_test_job run a job that sends a message to Slack
WorkspaceApi run_teams_message_test_job POST /w/{workspace}/workspaces/run_teams_message_test_job run a job that sends a message to Teams
WorkspaceApi set_environment_variable POST /w/{workspace}/workspaces/set_environment_variable set environment variable
WorkspaceApi set_threshold_alert POST /w/{workspace}/workspaces/threshold_alert set threshold alert info
WorkspaceApi set_workspace_encryption_key POST /w/{workspace}/workspaces/encryption_key update the encryption key for this workspace
WorkspaceApi set_workspace_slack_oauth_config POST /w/{workspace}/workspaces/slack_oauth_config set workspace slack oauth config
WorkspaceApi unarchive_workspace POST /workspaces/unarchive/{workspace} unarchive workspace
WorkspaceApi update_operator_settings POST /w/{workspace}/workspaces/operator_settings Update operator settings for a workspace
WorkspaceApi update_protection_rule POST /w/{workspace}/workspaces/protection_rules/{rule_name} update an existing protection rule
WorkspaceApi update_shared_ui PUT /w/{workspace}/shared_ui replace the workspace shared UI folder (admin only)
WorkspaceApi upload_ai_skills POST /w/{workspace}/ai_skills/upload upsert workspace AI chat skills (admin only)
WorkspaceDependenciesApi archive_workspace_dependencies POST /w/{workspace}/workspace_dependencies/archive/{language} archive workspace dependencies (require admin)
WorkspaceDependenciesApi create_workspace_dependencies POST /w/{workspace}/workspace_dependencies/create create workspace dependencies
WorkspaceDependenciesApi delete_workspace_dependencies POST /w/{workspace}/workspace_dependencies/delete/{language} delete workspace dependencies (require admin)
WorkspaceDependenciesApi get_latest_workspace_dependencies GET /w/{workspace}/workspace_dependencies/get_latest/{language} get latest workspace dependencies by language and name
WorkspaceDependenciesApi list_workspace_dependencies GET /w/{workspace}/workspace_dependencies/list list all workspace dependencies
WorkspaceIntegrationApi check_if_native_triggers_service_exists GET /w/{workspace}/native_triggers/integrations/{service_name}/exists check if integrations for a particular service exists
WorkspaceIntegrationApi check_instance_sharing_available GET /w/{workspace}/native_triggers/integrations/{service_name}/instance_sharing_available check if instance-level credential sharing is available for a service
WorkspaceIntegrationApi create_native_trigger_service POST /w/{workspace}/native_triggers/integrations/{service_name}/create create native trigger service
WorkspaceIntegrationApi delete_native_trigger_service DELETE /w/{workspace}/native_triggers/integrations/{service_name}/delete delete native trigger service
WorkspaceIntegrationApi generate_instance_connect_url POST /w/{workspace}/native_triggers/integrations/{service_name}/generate_instance_connect_url generate connect url using instance-level credentials
WorkspaceIntegrationApi generate_native_trigger_service_connect_url POST /w/{workspace}/native_triggers/integrations/{service_name}/generate_connect_url generate connect url for native trigger service
WorkspaceIntegrationApi list_native_trigger_services GET /w/{workspace}/native_triggers/integrations/list list available native trigger services
WorkspaceIntegrationApi native_trigger_service_callback POST /w/{workspace}/native_triggers/integrations/{service_name}/callback native trigger service oauth callback

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

contact@windmill.dev