kestra-api-client 1.0.0
Kestra EE
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Kestra EE

# @kestra-io/kestra_api_client
All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.<br/>
Endpoints designated as Superadmin-only are not tenant-scoped.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 1.0.0
- Generator version: 7.16.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import kestra_api_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import kestra_api_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import kestra_api_client
from kestra_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kestra_api_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with kestra_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kestra_api_client.AIApi(api_client)
    tenant = 'tenant_example' # str | 
    flow_generation_prompt = kestra_api_client.FlowGenerationPrompt() # FlowGenerationPrompt | Prompt and context required for flow generation

    try:
        # Generate or regenerate a flow based on a prompt
        api_response = api_instance.generate_flow(tenant, flow_generation_prompt)
        print("The response of AIApi->generate_flow:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AIApi->generate_flow: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AIApi* | [**generate_flow**](docs/AIApi.md#generate_flow) | **POST** /api/v1/{tenant}/ai/generate/flow | Generate or regenerate a flow based on a prompt
*AppsApi* | [**bulk_delete_apps**](docs/AppsApi.md#bulk_delete_apps) | **DELETE** /api/v1/{tenant}/apps | Delete existing apps
*AppsApi* | [**bulk_disable_apps**](docs/AppsApi.md#bulk_disable_apps) | **POST** /api/v1/{tenant}/apps/disable | Disable existing apps
*AppsApi* | [**bulk_enable_apps**](docs/AppsApi.md#bulk_enable_apps) | **POST** /api/v1/{tenant}/apps/enable | Enable existing apps
*AppsApi* | [**bulk_export_apps**](docs/AppsApi.md#bulk_export_apps) | **POST** /api/v1/{tenant}/apps/export | Export apps as a ZIP archive of YAML sources.
*AppsApi* | [**create_app**](docs/AppsApi.md#create_app) | **POST** /api/v1/{tenant}/apps | Create a new app
*AppsApi* | [**delete_app**](docs/AppsApi.md#delete_app) | **DELETE** /api/v1/{tenant}/apps/{uid} | Delete an existing app
*AppsApi* | [**disable_app**](docs/AppsApi.md#disable_app) | **POST** /api/v1/{tenant}/apps/{uid}/disable | Disable the app.
*AppsApi* | [**dispatch_app**](docs/AppsApi.md#dispatch_app) | **POST** /api/v1/{tenant}/apps/view/{id}/dispatch/{dispatch} | Dispatch for a given app.
*AppsApi* | [**download_file_from_app_execution**](docs/AppsApi.md#download_file_from_app_execution) | **GET** /api/v1/{tenant}/apps/view/{id}/file/download | Download file from an app execution
*AppsApi* | [**enable_app**](docs/AppsApi.md#enable_app) | **POST** /api/v1/{tenant}/apps/{uid}/enable | Enable the app.
*AppsApi* | [**get_app**](docs/AppsApi.md#get_app) | **GET** /api/v1/{tenant}/apps/{uid} | Retrieve an app
*AppsApi* | [**get_file_meta_from_app_execution**](docs/AppsApi.md#get_file_meta_from_app_execution) | **GET** /api/v1/{tenant}/apps/view/{id}/file/meta | Get file meta information from an app execution
*AppsApi* | [**get_file_preview_from_app_execution**](docs/AppsApi.md#get_file_preview_from_app_execution) | **GET** /api/v1/{tenant}/apps/view/{id}/file/preview | Get file preview from an app execution
*AppsApi* | [**get_logs_from_app_execution**](docs/AppsApi.md#get_logs_from_app_execution) | **GET** /api/v1/{tenant}/apps/view/{uid}/logs/download | Download logs for an app execution
*AppsApi* | [**get_stream_events_from_app**](docs/AppsApi.md#get_stream_events_from_app) | **GET** /api/v1/{tenant}/apps/view/{id}/streams/{stream} | Get an event stream from a given app.
*AppsApi* | [**list_tags**](docs/AppsApi.md#list_tags) | **GET** /api/v1/{tenant}/apps/tags | Get all the app tags
*AppsApi* | [**open_app**](docs/AppsApi.md#open_app) | **GET** /api/v1/{tenant}/apps/view/{uid} | Open an app
*AppsApi* | [**preview_app**](docs/AppsApi.md#preview_app) | **POST** /api/v1/{tenant}/apps/preview | Open the app for the given source
*AppsApi* | [**search_apps**](docs/AppsApi.md#search_apps) | **GET** /api/v1/{tenant}/apps/search | Search for apps
*AppsApi* | [**search_apps_from_catalog**](docs/AppsApi.md#search_apps_from_catalog) | **GET** /api/v1/{tenant}/apps/catalog | Search for apps from catalog
*AppsApi* | [**update_app**](docs/AppsApi.md#update_app) | **PUT** /api/v1/{tenant}/apps/{uid} | Update an existing app
*AuditLogsApi* | [**export_audit_logs**](docs/AuditLogsApi.md#export_audit_logs) | **GET** /api/v1/{tenant}/auditlogs/export | Export all audit logs as a streamed CSV file
*AuditLogsApi* | [**find_audit_log**](docs/AuditLogsApi.md#find_audit_log) | **POST** /api/v1/{tenant}/auditlogs/find | Find a specific audit log
*AuditLogsApi* | [**get_global_resource_diff_from_audit_log**](docs/AuditLogsApi.md#get_global_resource_diff_from_audit_log) | **GET** /api/v1/auditlogs/{id}/diff | Retrieve the diff between audit logs from global resource like users
*AuditLogsApi* | [**get_resource_diff_from_audit_log**](docs/AuditLogsApi.md#get_resource_diff_from_audit_log) | **GET** /api/v1/{tenant}/auditlogs/{id}/diff | Retrieve the diff between audit logs
*AuditLogsApi* | [**list_audit_log_from_resource_id**](docs/AuditLogsApi.md#list_audit_log_from_resource_id) | **GET** /api/v1/{tenant}/auditlogs/history/{detailId} | Find all audit logs about a specific resource.
*AuditLogsApi* | [**search_audit_logs**](docs/AuditLogsApi.md#search_audit_logs) | **GET** /api/v1/{tenant}/auditlogs/search | Search for audit logs
*AuditLogsApi* | [**search_audit_logs_for_all_tenants**](docs/AuditLogsApi.md#search_audit_logs_for_all_tenants) | **GET** /api/v1/auditlogs/search | Search for audit logs across all tenants, required to be SuperAdmin
*AuthsApi* | [**create_api_token_for_current_user**](docs/AuthsApi.md#create_api_token_for_current_user) | **POST** /api/v1/me/api-tokens | Create API token for the authenticated user
*AuthsApi* | [**delete_api_token_for_current_user**](docs/AuthsApi.md#delete_api_token_for_current_user) | **DELETE** /api/v1/me/api-tokens/{tokenId} | Delete API token for the authenticated user
*AuthsApi* | [**get_current_user**](docs/AuthsApi.md#get_current_user) | **GET** /api/v1/me | Get details about the authenticated user
*AuthsApi* | [**index**](docs/AuthsApi.md#index) | **GET** /api/v1/auths | Retrieve list of authentication methods
*AuthsApi* | [**list_api_tokens_for_current_user**](docs/AuthsApi.md#list_api_tokens_for_current_user) | **GET** /api/v1/me/api-tokens | List API tokens for authenticated user
*AuthsApi* | [**patch_current_user**](docs/AuthsApi.md#patch_current_user) | **PATCH** /api/v1/me | Update authenticated user details
*BannersApi* | [**create_banner**](docs/BannersApi.md#create_banner) | **POST** /api/v1/banners | Create an announcement banner
*BannersApi* | [**delete_banner**](docs/BannersApi.md#delete_banner) | **DELETE** /api/v1/banners/{id} | Delete an announcement banner
*BannersApi* | [**search_banners**](docs/BannersApi.md#search_banners) | **GET** /api/v1/banners/search | Retrieve all announcement banners
*BannersApi* | [**update_banner**](docs/BannersApi.md#update_banner) | **PUT** /api/v1/banners/{id} | Update an announcement banner
*BindingsApi* | [**bulk_create_binding**](docs/BindingsApi.md#bulk_create_binding) | **POST** /api/v1/{tenant}/bindings/bulk | Create multiple bindings
*BindingsApi* | [**create_binding**](docs/BindingsApi.md#create_binding) | **POST** /api/v1/{tenant}/bindings | Create a binding
*BindingsApi* | [**delete_binding**](docs/BindingsApi.md#delete_binding) | **DELETE** /api/v1/{tenant}/bindings/{id} | Delete a binding
*BindingsApi* | [**get_binding**](docs/BindingsApi.md#get_binding) | **GET** /api/v1/{tenant}/bindings/{id} | Retrieve a binding
*BindingsApi* | [**search_bindings**](docs/BindingsApi.md#search_bindings) | **GET** /api/v1/{tenant}/bindings/search | Search for bindings
*BlueprintTagsApi* | [**internal_blueprint_tags**](docs/BlueprintTagsApi.md#internal_blueprint_tags) | **GET** /api/v1/{tenant}/blueprints/custom/tags | List all internal blueprint tags
*BlueprintTagsApi* | [**list_blueprint_tags**](docs/BlueprintTagsApi.md#list_blueprint_tags) | **GET** /api/v1/{tenant}/blueprints/community/{kind}/tags | List blueprint tags matching the filter
*BlueprintsApi* | [**create_internal_blueprints**](docs/BlueprintsApi.md#create_internal_blueprints) | **POST** /api/v1/{tenant}/blueprints/custom | Create a new internal blueprint
*BlueprintsApi* | [**delete_internal_blueprints**](docs/BlueprintsApi.md#delete_internal_blueprints) | **DELETE** /api/v1/{tenant}/blueprints/custom/{id} | Delete an internal blueprint
*BlueprintsApi* | [**get_blueprint**](docs/BlueprintsApi.md#get_blueprint) | **GET** /api/v1/{tenant}/blueprints/community/{kind}/{id} | Retrieve a blueprint
*BlueprintsApi* | [**get_blueprint_graph**](docs/BlueprintsApi.md#get_blueprint_graph) | **GET** /api/v1/{tenant}/blueprints/community/{kind}/{id}/graph | Retrieve a blueprint graph
*BlueprintsApi* | [**get_blueprint_source**](docs/BlueprintsApi.md#get_blueprint_source) | **GET** /api/v1/{tenant}/blueprints/community/{kind}/{id}/source | Retrieve a blueprint source code
*BlueprintsApi* | [**internal_blueprint**](docs/BlueprintsApi.md#internal_blueprint) | **GET** /api/v1/{tenant}/blueprints/custom/{id} | Retrieve an internal blueprint
*BlueprintsApi* | [**internal_blueprint_flow**](docs/BlueprintsApi.md#internal_blueprint_flow) | **GET** /api/v1/{tenant}/blueprints/custom/{id}/source | Retrieve an internal blueprint source code
*BlueprintsApi* | [**search_blueprints**](docs/BlueprintsApi.md#search_blueprints) | **GET** /api/v1/{tenant}/blueprints/community/{kind} | List all blueprints
*BlueprintsApi* | [**search_internal_blueprints**](docs/BlueprintsApi.md#search_internal_blueprints) | **GET** /api/v1/{tenant}/blueprints/custom | List all internal blueprints
*BlueprintsApi* | [**update_internal_blueprints**](docs/BlueprintsApi.md#update_internal_blueprints) | **PUT** /api/v1/{tenant}/blueprints/custom/{id} | Update an internal blueprint
*ClusterApi* | [**enter_maintenance**](docs/ClusterApi.md#enter_maintenance) | **POST** /api/v1/instance/maintenance/enter | Enter cluster maintenance mode
*ClusterApi* | [**exit_maintenance**](docs/ClusterApi.md#exit_maintenance) | **POST** /api/v1/instance/maintenance/exit | Exit cluster maintenance mode
*DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **POST** /api/v1/{tenant}/dashboards | Create a dashboard from yaml source
*DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /api/v1/{tenant}/dashboards/{id} | Delete a dashboard
*DashboardsApi* | [**export_chart_to_csv**](docs/DashboardsApi.md#export_chart_to_csv) | **POST** /api/v1/{tenant}/dashboards/charts/export/to-csv | Export a table chart data to CSV
*DashboardsApi* | [**export_dashboard_chart_data_to_csv**](docs/DashboardsApi.md#export_dashboard_chart_data_to_csv) | **POST** /api/v1/{tenant}/dashboards/{id}/charts/{chartId}/export/to-csv | Export a dashboard chart data to CSV
*DashboardsApi* | [**get_dashboard**](docs/DashboardsApi.md#get_dashboard) | **GET** /api/v1/{tenant}/dashboards/{id} | Get a dashboard
*DashboardsApi* | [**get_dashboard_chart_data**](docs/DashboardsApi.md#get_dashboard_chart_data) | **POST** /api/v1/{tenant}/dashboards/{id}/charts/{chartId} | Generate a dashboard chart data
*DashboardsApi* | [**preview_chart**](docs/DashboardsApi.md#preview_chart) | **POST** /api/v1/{tenant}/dashboards/charts/preview | Preview a chart data
*DashboardsApi* | [**search_dashboards**](docs/DashboardsApi.md#search_dashboards) | **GET** /api/v1/{tenant}/dashboards | Search for dashboards
*DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **PUT** /api/v1/{tenant}/dashboards/{id} | Update a dashboard
*DashboardsApi* | [**validate_chart**](docs/DashboardsApi.md#validate_chart) | **POST** /api/v1/{tenant}/dashboards/validate/chart | Validate a chart from yaml source
*DashboardsApi* | [**validate_dashboard**](docs/DashboardsApi.md#validate_dashboard) | **POST** /api/v1/{tenant}/dashboards/validate | Validate dashboard from yaml source
*ExecutionsApi* | [**create_execution**](docs/ExecutionsApi.md#create_execution) | **POST** /api/v1/{tenant}/executions/{namespace}/{id} | Create a new execution for a flow
*ExecutionsApi* | [**delete_execution**](docs/ExecutionsApi.md#delete_execution) | **DELETE** /api/v1/{tenant}/executions/{executionId} | Delete an execution
*ExecutionsApi* | [**delete_executions_by_ids**](docs/ExecutionsApi.md#delete_executions_by_ids) | **DELETE** /api/v1/{tenant}/executions/by-ids | Delete a list of executions
*ExecutionsApi* | [**delete_executions_by_query**](docs/ExecutionsApi.md#delete_executions_by_query) | **DELETE** /api/v1/{tenant}/executions/by-query | Delete executions filter by query parameters
*ExecutionsApi* | [**download_file_from_execution**](docs/ExecutionsApi.md#download_file_from_execution) | **GET** /api/v1/{tenant}/executions/{executionId}/file | Download file for an execution
*ExecutionsApi* | [**eval_task_run_expression**](docs/ExecutionsApi.md#eval_task_run_expression) | **POST** /api/v1/{tenant}/executions/{executionId}/eval/{taskRunId} | Evaluate a variable expression for this taskrun
*ExecutionsApi* | [**follow_dependencies_executions**](docs/ExecutionsApi.md#follow_dependencies_executions) | **GET** /api/v1/{tenant}/executions/{executionId}/follow-dependencies | Follow all execution dependencies executions
*ExecutionsApi* | [**follow_execution**](docs/ExecutionsApi.md#follow_execution) | **GET** /api/v1/{tenant}/executions/{executionId}/follow | Follow an execution
*ExecutionsApi* | [**force_run_by_ids**](docs/ExecutionsApi.md#force_run_by_ids) | **POST** /api/v1/{tenant}/executions/force-run/by-ids | Force run a list of executions
*ExecutionsApi* | [**force_run_execution**](docs/ExecutionsApi.md#force_run_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/force-run | Force run an execution
*ExecutionsApi* | [**force_run_executions_by_query**](docs/ExecutionsApi.md#force_run_executions_by_query) | **POST** /api/v1/{tenant}/executions/force-run/by-query | Force run executions filter by query parameters
*ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /api/v1/{tenant}/executions/{executionId} | Get an execution
*ExecutionsApi* | [**get_execution_flow_graph**](docs/ExecutionsApi.md#get_execution_flow_graph) | **GET** /api/v1/{tenant}/executions/{executionId}/graph | Generate a graph for an execution
*ExecutionsApi* | [**get_file_metadatas_from_execution**](docs/ExecutionsApi.md#get_file_metadatas_from_execution) | **GET** /api/v1/{tenant}/executions/{executionId}/file/metas | Get file meta information for an execution
*ExecutionsApi* | [**get_flow_from_execution**](docs/ExecutionsApi.md#get_flow_from_execution) | **GET** /api/v1/{tenant}/executions/flows/{namespace}/{flowId} | Get flow information&#39;s for an execution
*ExecutionsApi* | [**get_flow_from_execution_by_id**](docs/ExecutionsApi.md#get_flow_from_execution_by_id) | **GET** /api/v1/{tenant}/executions/{executionId}/flow | Get flow information&#39;s for an execution
*ExecutionsApi* | [**get_latest_executions**](docs/ExecutionsApi.md#get_latest_executions) | **POST** /api/v1/{tenant}/executions/latest | Get the latest execution for given flows
*ExecutionsApi* | [**kill_execution**](docs/ExecutionsApi.md#kill_execution) | **DELETE** /api/v1/{tenant}/executions/{executionId}/kill | Kill an execution
*ExecutionsApi* | [**kill_executions_by_ids**](docs/ExecutionsApi.md#kill_executions_by_ids) | **DELETE** /api/v1/{tenant}/executions/kill/by-ids | Kill a list of executions
*ExecutionsApi* | [**kill_executions_by_query**](docs/ExecutionsApi.md#kill_executions_by_query) | **DELETE** /api/v1/{tenant}/executions/kill/by-query | Kill executions filter by query parameters
*ExecutionsApi* | [**list_executable_distinct_namespaces**](docs/ExecutionsApi.md#list_executable_distinct_namespaces) | **GET** /api/v1/{tenant}/executions/namespaces | Get all namespaces that have executable flows
*ExecutionsApi* | [**list_flow_executions_by_namespace**](docs/ExecutionsApi.md#list_flow_executions_by_namespace) | **GET** /api/v1/{tenant}/executions/namespaces/{namespace}/flows | Get all flow ids for a namespace. Data returned are FlowForExecution containing minimal information about a Flow for when you are allowed to executing but not reading.
*ExecutionsApi* | [**pause_execution**](docs/ExecutionsApi.md#pause_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/pause | Pause a running execution.
*ExecutionsApi* | [**pause_executions_by_ids**](docs/ExecutionsApi.md#pause_executions_by_ids) | **POST** /api/v1/{tenant}/executions/pause/by-ids | Pause a list of running executions
*ExecutionsApi* | [**pause_executions_by_query**](docs/ExecutionsApi.md#pause_executions_by_query) | **POST** /api/v1/{tenant}/executions/pause/by-query | Pause executions filter by query parameters
*ExecutionsApi* | [**preview_file_from_execution**](docs/ExecutionsApi.md#preview_file_from_execution) | **GET** /api/v1/{tenant}/executions/{executionId}/file/preview | Get file preview for an execution
*ExecutionsApi* | [**replay_execution**](docs/ExecutionsApi.md#replay_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/replay | Create a new execution from an old one and start it from a specified task run id
*ExecutionsApi* | [**replay_execution_withinputs**](docs/ExecutionsApi.md#replay_execution_withinputs) | **POST** /api/v1/{tenant}/executions/{executionId}/replay-with-inputs | Create a new execution from an old one and start it from a specified task run id
*ExecutionsApi* | [**replay_executions_by_ids**](docs/ExecutionsApi.md#replay_executions_by_ids) | **POST** /api/v1/{tenant}/executions/replay/by-ids | Create new executions from old ones. Keep the flow revision
*ExecutionsApi* | [**replay_executions_by_query**](docs/ExecutionsApi.md#replay_executions_by_query) | **POST** /api/v1/{tenant}/executions/replay/by-query | Create new executions from old ones filter by query parameters. Keep the flow revision
*ExecutionsApi* | [**restart_execution**](docs/ExecutionsApi.md#restart_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/restart | Restart a new execution from an old one
*ExecutionsApi* | [**restart_executions_by_ids**](docs/ExecutionsApi.md#restart_executions_by_ids) | **POST** /api/v1/{tenant}/executions/restart/by-ids | Restart a list of executions
*ExecutionsApi* | [**restart_executions_by_query**](docs/ExecutionsApi.md#restart_executions_by_query) | **POST** /api/v1/{tenant}/executions/restart/by-query | Restart executions filter by query parameters
*ExecutionsApi* | [**resume_execution**](docs/ExecutionsApi.md#resume_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/resume | Resume a paused execution.
*ExecutionsApi* | [**resume_execution_from_breakpoint**](docs/ExecutionsApi.md#resume_execution_from_breakpoint) | **POST** /api/v1/{tenant}/executions/{executionId}/resume-from-breakpoint | Resume an execution from a breakpoint (in the &#39;BREAKPOINT&#39; state).
*ExecutionsApi* | [**resume_executions_by_ids**](docs/ExecutionsApi.md#resume_executions_by_ids) | **POST** /api/v1/{tenant}/executions/resume/by-ids | Resume a list of paused executions
*ExecutionsApi* | [**resume_executions_by_query**](docs/ExecutionsApi.md#resume_executions_by_query) | **POST** /api/v1/{tenant}/executions/resume/by-query | Resume executions filter by query parameters
*ExecutionsApi* | [**search_executions**](docs/ExecutionsApi.md#search_executions) | **GET** /api/v1/{tenant}/executions/search | Search for executions
*ExecutionsApi* | [**search_executions_by_flow_id**](docs/ExecutionsApi.md#search_executions_by_flow_id) | **GET** /api/v1/{tenant}/executions | Search for executions for a flow
*ExecutionsApi* | [**search_task_run**](docs/ExecutionsApi.md#search_task_run) | **GET** /api/v1/{tenant}/taskruns/search | Search for taskruns, only available with the Elasticsearch repository
*ExecutionsApi* | [**set_labels_on_terminated_execution**](docs/ExecutionsApi.md#set_labels_on_terminated_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/labels | Add or update labels of a terminated execution
*ExecutionsApi* | [**set_labels_on_terminated_executions_by_ids**](docs/ExecutionsApi.md#set_labels_on_terminated_executions_by_ids) | **POST** /api/v1/{tenant}/executions/labels/by-ids | Set labels on a list of executions
*ExecutionsApi* | [**set_labels_on_terminated_executions_by_query**](docs/ExecutionsApi.md#set_labels_on_terminated_executions_by_query) | **POST** /api/v1/{tenant}/executions/labels/by-query | Set label on executions filter by query parameters
*ExecutionsApi* | [**trigger_execution**](docs/ExecutionsApi.md#trigger_execution) | **POST** /api/v1/{tenant}/executions/trigger/{namespace}/{id} | Trigger a new execution for a flow
*ExecutionsApi* | [**trigger_execution_by_get_webhook**](docs/ExecutionsApi.md#trigger_execution_by_get_webhook) | **GET** /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key} | Trigger a new execution by GET webhook trigger
*ExecutionsApi* | [**trigger_execution_by_post_webhook**](docs/ExecutionsApi.md#trigger_execution_by_post_webhook) | **POST** /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key} | Trigger a new execution by POST webhook trigger
*ExecutionsApi* | [**trigger_execution_by_put_webhook**](docs/ExecutionsApi.md#trigger_execution_by_put_webhook) | **PUT** /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key} | Trigger a new execution by PUT webhook trigger
*ExecutionsApi* | [**unqueue_execution**](docs/ExecutionsApi.md#unqueue_execution) | **POST** /api/v1/{tenant}/executions/{executionId}/unqueue | Unqueue an execution
*ExecutionsApi* | [**unqueue_executions_by_ids**](docs/ExecutionsApi.md#unqueue_executions_by_ids) | **POST** /api/v1/{tenant}/executions/unqueue/by-ids | Unqueue a list of executions
*ExecutionsApi* | [**unqueue_executions_by_query**](docs/ExecutionsApi.md#unqueue_executions_by_query) | **POST** /api/v1/{tenant}/executions/unqueue/by-query | Unqueue executions filter by query parameters
*ExecutionsApi* | [**update_execution_status**](docs/ExecutionsApi.md#update_execution_status) | **POST** /api/v1/{tenant}/executions/{executionId}/change-status | Change the state of an execution
*ExecutionsApi* | [**update_executions_status_by_ids**](docs/ExecutionsApi.md#update_executions_status_by_ids) | **POST** /api/v1/{tenant}/executions/change-status/by-ids | Change executions state by id
*ExecutionsApi* | [**update_executions_status_by_query**](docs/ExecutionsApi.md#update_executions_status_by_query) | **POST** /api/v1/{tenant}/executions/change-status/by-query | Change executions state by query parameters
*ExecutionsApi* | [**update_task_run_state**](docs/ExecutionsApi.md#update_task_run_state) | **POST** /api/v1/{tenant}/executions/{executionId}/state | Change state for a taskrun in an execution
*ExecutionsApi* | [**validate_new_execution_inputs**](docs/ExecutionsApi.md#validate_new_execution_inputs) | **POST** /api/v1/{tenant}/executions/{namespace}/{id}/validate | Validate the creation of a new execution for a flow
*ExecutionsApi* | [**validate_resume_execution_inputs**](docs/ExecutionsApi.md#validate_resume_execution_inputs) | **POST** /api/v1/{tenant}/executions/{executionId}/resume/validate | Validate inputs to resume a paused execution.
*FilesApi* | [**create_namespace_directory**](docs/FilesApi.md#create_namespace_directory) | **POST** /api/v1/{tenant}/namespaces/{namespace}/files/directory | Create a directory
*FilesApi* | [**create_namespace_file**](docs/FilesApi.md#create_namespace_file) | **POST** /api/v1/{tenant}/namespaces/{namespace}/files | Create a file
*FilesApi* | [**delete_file_directory**](docs/FilesApi.md#delete_file_directory) | **DELETE** /api/v1/{tenant}/namespaces/{namespace}/files | Delete a file or directory
*FilesApi* | [**export_namespace_files**](docs/FilesApi.md#export_namespace_files) | **GET** /api/v1/{tenant}/namespaces/{namespace}/files/export | Export namespace files as a ZIP
*FilesApi* | [**get_file_content**](docs/FilesApi.md#get_file_content) | **GET** /api/v1/{tenant}/namespaces/{namespace}/files | Get namespace file content
*FilesApi* | [**get_file_metadatas**](docs/FilesApi.md#get_file_metadatas) | **GET** /api/v1/{tenant}/namespaces/{namespace}/files/stats | Get namespace file stats such as size, creation &amp; modification dates and type
*FilesApi* | [**list_namespace_directory_files**](docs/FilesApi.md#list_namespace_directory_files) | **GET** /api/v1/{tenant}/namespaces/{namespace}/files/directory | List directory content
*FilesApi* | [**move_file_directory**](docs/FilesApi.md#move_file_directory) | **PUT** /api/v1/{tenant}/namespaces/{namespace}/files | Move a file or directory
*FilesApi* | [**search_namespace_files**](docs/FilesApi.md#search_namespace_files) | **GET** /api/v1/{tenant}/namespaces/{namespace}/files/search | Find files which path contain the given string in their URI
*FlowsApi* | [**bulk_import_apps**](docs/FlowsApi.md#bulk_import_apps) | **POST** /api/v1/{tenant}/apps/import |     Import apps as a ZIP archive of yaml sources or a multi-objects YAML file.     When sending a Yaml that contains one or more apps, a list of index is returned.     When sending a ZIP archive, a list of files that couldn&#39;t be imported is returned. 
*FlowsApi* | [**bulk_update_flows**](docs/FlowsApi.md#bulk_update_flows) | **POST** /api/v1/{tenant}/flows/bulk | Update from multiples yaml sources
*FlowsApi* | [**create_flow**](docs/FlowsApi.md#create_flow) | **POST** /api/v1/{tenant}/flows | Create a flow from yaml source
*FlowsApi* | [**delete_flow**](docs/FlowsApi.md#delete_flow) | **DELETE** /api/v1/{tenant}/flows/{namespace}/{id} | Delete a flow
*FlowsApi* | [**delete_flows_by_ids**](docs/FlowsApi.md#delete_flows_by_ids) | **DELETE** /api/v1/{tenant}/flows/delete/by-ids | Delete flows by their IDs.
*FlowsApi* | [**delete_flows_by_query**](docs/FlowsApi.md#delete_flows_by_query) | **DELETE** /api/v1/{tenant}/flows/delete/by-query | Delete flows returned by the query parameters.
*FlowsApi* | [**disable_flows_by_ids**](docs/FlowsApi.md#disable_flows_by_ids) | **POST** /api/v1/{tenant}/flows/disable/by-ids | Disable flows by their IDs.
*FlowsApi* | [**disable_flows_by_query**](docs/FlowsApi.md#disable_flows_by_query) | **POST** /api/v1/{tenant}/flows/disable/by-query | Disable flows returned by the query parameters.
*FlowsApi* | [**enable_flows_by_ids**](docs/FlowsApi.md#enable_flows_by_ids) | **POST** /api/v1/{tenant}/flows/enable/by-ids | Enable flows by their IDs.
*FlowsApi* | [**enable_flows_by_query**](docs/FlowsApi.md#enable_flows_by_query) | **POST** /api/v1/{tenant}/flows/enable/by-query | Enable flows returned by the query parameters.
*FlowsApi* | [**export_flows_by_ids**](docs/FlowsApi.md#export_flows_by_ids) | **POST** /api/v1/{tenant}/flows/export/by-ids | Export flows as a ZIP archive of yaml sources.
*FlowsApi* | [**export_flows_by_query**](docs/FlowsApi.md#export_flows_by_query) | **GET** /api/v1/{tenant}/flows/export/by-query | Export flows as a ZIP archive of yaml sources.
*FlowsApi* | [**generate_flow_graph**](docs/FlowsApi.md#generate_flow_graph) | **GET** /api/v1/{tenant}/flows/{namespace}/{id}/graph | Generate a graph for a flow
*FlowsApi* | [**generate_flow_graph_from_source**](docs/FlowsApi.md#generate_flow_graph_from_source) | **POST** /api/v1/{tenant}/flows/graph | Generate a graph for a flow source
*FlowsApi* | [**get_flow**](docs/FlowsApi.md#get_flow) | **GET** /api/v1/{tenant}/flows/{namespace}/{id} | Get a flow
*FlowsApi* | [**get_flow_dependencies**](docs/FlowsApi.md#get_flow_dependencies) | **GET** /api/v1/{tenant}/flows/{namespace}/{id}/dependencies | Get flow dependencies
*FlowsApi* | [**get_flow_dependencies_from_namespace**](docs/FlowsApi.md#get_flow_dependencies_from_namespace) | **GET** /api/v1/{tenant}/namespaces/{namespace}/dependencies | Retrieve flow dependencies
*FlowsApi* | [**get_task_from_flow**](docs/FlowsApi.md#get_task_from_flow) | **GET** /api/v1/{tenant}/flows/{namespace}/{id}/tasks/{taskId} | Get a flow task
*FlowsApi* | [**import_flows**](docs/FlowsApi.md#import_flows) | **POST** /api/v1/{tenant}/flows/import |     Import flows as a ZIP archive of yaml sources or a multi-objects YAML file.     When sending a Yaml that contains one or more flows, a list of index is returned.     When sending a ZIP archive, a list of files that couldn&#39;t be imported is returned. 
*FlowsApi* | [**list_distinct_namespaces**](docs/FlowsApi.md#list_distinct_namespaces) | **GET** /api/v1/{tenant}/flows/distinct-namespaces | List all distinct namespaces
*FlowsApi* | [**list_flow_revisions**](docs/FlowsApi.md#list_flow_revisions) | **GET** /api/v1/{tenant}/flows/{namespace}/{id}/revisions | Get revisions for a flow
*FlowsApi* | [**list_flows_by_namespace**](docs/FlowsApi.md#list_flows_by_namespace) | **GET** /api/v1/{tenant}/flows/{namespace} | Retrieve all flows from a given namespace
*FlowsApi* | [**search_flows**](docs/FlowsApi.md#search_flows) | **GET** /api/v1/{tenant}/flows/search | Search for flows
*FlowsApi* | [**search_flows_by_source_code**](docs/FlowsApi.md#search_flows_by_source_code) | **GET** /api/v1/{tenant}/flows/source | Search for flows source code
*FlowsApi* | [**update_flow**](docs/FlowsApi.md#update_flow) | **PUT** /api/v1/{tenant}/flows/{namespace}/{id} | Update a flow
*FlowsApi* | [**update_flows_in_namespace_from_json**](docs/FlowsApi.md#update_flows_in_namespace_from_json) | **POST** /api/v1/{tenant}/flows/{namespace} | Update a complete namespace from json object
*FlowsApi* | [**update_task**](docs/FlowsApi.md#update_task) | **PATCH** /api/v1/{tenant}/flows/{namespace}/{id}/{taskId} | Update a single task on a flow
*FlowsApi* | [**validate_flows**](docs/FlowsApi.md#validate_flows) | **POST** /api/v1/{tenant}/flows/validate | Validate a list of flows
*FlowsApi* | [**validate_task**](docs/FlowsApi.md#validate_task) | **POST** /api/v1/{tenant}/flows/validate/task | Validate a task
*FlowsApi* | [**validate_trigger**](docs/FlowsApi.md#validate_trigger) | **POST** /api/v1/{tenant}/flows/validate/trigger | Validate trigger
*GroupsApi* | [**add_user_to_group**](docs/GroupsApi.md#add_user_to_group) | **PUT** /api/v1/{tenant}/groups/{id}/members/{userId} | Add a user to a group
*GroupsApi* | [**autocomplete_groups**](docs/GroupsApi.md#autocomplete_groups) | **POST** /api/v1/{tenant}/groups/autocomplete | List groups for autocomplete
*GroupsApi* | [**create_group**](docs/GroupsApi.md#create_group) | **POST** /api/v1/{tenant}/groups | Create a group
*GroupsApi* | [**delete_group**](docs/GroupsApi.md#delete_group) | **DELETE** /api/v1/{tenant}/groups/{id} | Delete a group
*GroupsApi* | [**delete_user_from_group**](docs/GroupsApi.md#delete_user_from_group) | **DELETE** /api/v1/{tenant}/groups/{id}/members/{userId} | Remove a user from a group
*GroupsApi* | [**get_group**](docs/GroupsApi.md#get_group) | **GET** /api/v1/{tenant}/groups/{id} | Retrieve a group
*GroupsApi* | [**list_group_ids**](docs/GroupsApi.md#list_group_ids) | **POST** /api/v1/{tenant}/groups/ids | List groups by ids
*GroupsApi* | [**search_group_members**](docs/GroupsApi.md#search_group_members) | **GET** /api/v1/{tenant}/groups/{id}/members | Search for users in a group
*GroupsApi* | [**search_groups**](docs/GroupsApi.md#search_groups) | **GET** /api/v1/{tenant}/groups/search | Search for groups
*GroupsApi* | [**set_user_membership_for_group**](docs/GroupsApi.md#set_user_membership_for_group) | **PUT** /api/v1/{tenant}/groups/{id}/members/membership/{userId} | Update a user&#39;s membership type in a group
*GroupsApi* | [**update_group**](docs/GroupsApi.md#update_group) | **PUT** /api/v1/{tenant}/groups/{id} | Update a group
*InvitationsApi* | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | **POST** /api/v1/{tenant}/invitations | Create an invitation
*InvitationsApi* | [**delete_invitation**](docs/InvitationsApi.md#delete_invitation) | **DELETE** /api/v1/{tenant}/invitations/{id} | Delete an invitation
*InvitationsApi* | [**find_all_invitations_for_current_user**](docs/InvitationsApi.md#find_all_invitations_for_current_user) | **GET** /api/v1/me/invitations | List invitations for the authenticated user
*InvitationsApi* | [**get_invitation**](docs/InvitationsApi.md#get_invitation) | **GET** /api/v1/{tenant}/invitations/{id} | Retrieve an invitation
*InvitationsApi* | [**list_invitations_by_email**](docs/InvitationsApi.md#list_invitations_by_email) | **GET** /api/v1/{tenant}/invitations/email/{email} | Retrieve all invitations for a given email
*InvitationsApi* | [**search_invitations**](docs/InvitationsApi.md#search_invitations) | **GET** /api/v1/{tenant}/invitations/search | Search for invitations
*KVApi* | [**delete_key_value**](docs/KVApi.md#delete_key_value) | **DELETE** /api/v1/{tenant}/namespaces/{namespace}/kv/{key} | Delete a key-value pair
*KVApi* | [**delete_key_values**](docs/KVApi.md#delete_key_values) | **DELETE** /api/v1/{tenant}/namespaces/{namespace}/kv | Bulk-delete multiple key/value pairs from the given namespace.
*KVApi* | [**get_key_value**](docs/KVApi.md#get_key_value) | **GET** /api/v1/{tenant}/namespaces/{namespace}/kv/{key} | Get value for a key
*KVApi* | [**list_keys**](docs/KVApi.md#list_keys) | **GET** /api/v1/{tenant}/namespaces/{namespace}/kv | List all keys for a namespace
*KVApi* | [**list_keys_with_inheritence**](docs/KVApi.md#list_keys_with_inheritence) | **GET** /api/v1/{tenant}/namespaces/{namespace}/kv/inheritance | List all keys for a namespace and parent namespaces
*KVApi* | [**set_key_value**](docs/KVApi.md#set_key_value) | **PUT** /api/v1/{tenant}/namespaces/{namespace}/kv/{key} | Puts a key-value pair in store
*LogsApi* | [**delete_logs_from_execution**](docs/LogsApi.md#delete_logs_from_execution) | **DELETE** /api/v1/{tenant}/logs/{executionId} | Delete logs for a specific execution, taskrun or task
*LogsApi* | [**delete_logs_from_flow**](docs/LogsApi.md#delete_logs_from_flow) | **DELETE** /api/v1/{tenant}/logs/{namespace}/{flowId} | Delete logs for a specific execution, taskrun or task
*LogsApi* | [**download_logs_from_execution**](docs/LogsApi.md#download_logs_from_execution) | **GET** /api/v1/{tenant}/logs/{executionId}/download | Download logs for a specific execution, taskrun or task
*LogsApi* | [**follow_logs_from_execution**](docs/LogsApi.md#follow_logs_from_execution) | **GET** /api/v1/{tenant}/logs/{executionId}/follow | Follow logs for a specific execution
*LogsApi* | [**list_logs_from_execution**](docs/LogsApi.md#list_logs_from_execution) | **GET** /api/v1/{tenant}/logs/{executionId} | Get logs for a specific execution, taskrun or task
*LogsApi* | [**search_logs**](docs/LogsApi.md#search_logs) | **GET** /api/v1/{tenant}/logs/search | Search for logs
*MaintenanceApi* | [**enter_maintenance**](docs/MaintenanceApi.md#enter_maintenance) | **POST** /api/v1/instance/maintenance/enter | Enter cluster maintenance mode
*MaintenanceApi* | [**exit_maintenance**](docs/MaintenanceApi.md#exit_maintenance) | **POST** /api/v1/instance/maintenance/exit | Exit cluster maintenance mode
*MetricsApi* | [**aggregate_metrics_from_flow**](docs/MetricsApi.md#aggregate_metrics_from_flow) | **GET** /api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{metric} | Get metrics aggregations for a specific flow
*MetricsApi* | [**aggregate_metrics_from_task**](docs/MetricsApi.md#aggregate_metrics_from_task) | **GET** /api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{taskId}/{metric} | Get metrics aggregations for a specific flow
*MetricsApi* | [**list_flow_metrics**](docs/MetricsApi.md#list_flow_metrics) | **GET** /api/v1/{tenant}/metrics/names/{namespace}/{flowId} | Get metrics names for a specific flow
*MetricsApi* | [**list_task_metrics**](docs/MetricsApi.md#list_task_metrics) | **GET** /api/v1/{tenant}/metrics/names/{namespace}/{flowId}/{taskId} | Get metrics names for a specific task in a flow
*MetricsApi* | [**list_tasks_with_metrics**](docs/MetricsApi.md#list_tasks_with_metrics) | **GET** /api/v1/{tenant}/metrics/tasks/{namespace}/{flowId} | Get tasks id that have metrics for a specific flow, include deleted or renamed tasks
*MetricsApi* | [**search_by_execution**](docs/MetricsApi.md#search_by_execution) | **GET** /api/v1/{tenant}/metrics/{executionId} | Get metrics for a specific execution
*MiscApi* | [**create_basic_auth**](docs/MiscApi.md#create_basic_auth) | **POST** /api/v1/{tenant}/basicAuth | Configure basic authentication for the instance.
*MiscApi* | [**get_basic_auth_config_errors**](docs/MiscApi.md#get_basic_auth_config_errors) | **GET** /api/v1/basicAuthValidationErrors | Retrieve the instance configuration.
*MiscApi* | [**get_configuration**](docs/MiscApi.md#get_configuration) | **GET** /api/v1/configs | Retrieve the instance configuration.
*MiscApi* | [**get_usages**](docs/MiscApi.md#get_usages) | **GET** /api/v1/{tenant}/usages/all | Retrieve instance usage information
*MiscApi* | [**license_info**](docs/MiscApi.md#license_info) | **GET** /api/v1/license-info | Retrieve license information
*MiscApi* | [**list_actions**](docs/MiscApi.md#list_actions) | **GET** /api/v1/{tenant}/acls/actions | Retrieve list of actions
*MiscApi* | [**list_permissions**](docs/MiscApi.md#list_permissions) | **GET** /api/v1/{tenant}/acls/permissions | Retrieve list of permissions
*MiscApi* | [**setup_configuration**](docs/MiscApi.md#setup_configuration) | **GET** /api/v1/setup | Retrieve current setup configuration
*MiscApi* | [**setup_kestra**](docs/MiscApi.md#setup_kestra) | **POST** /api/v1/setup | Create the first Superadmin user
*MiscApi* | [**tenant_usage**](docs/MiscApi.md#tenant_usage) | **GET** /api/v1/{tenant}/usages | Retrieve usage information for the current tenant
*NamespacesApi* | [**autocomplete_namespaces**](docs/NamespacesApi.md#autocomplete_namespaces) | **POST** /api/v1/{tenant}/namespaces/autocomplete | List namespaces for autocomplete
*NamespacesApi* | [**create_namespace**](docs/NamespacesApi.md#create_namespace) | **POST** /api/v1/{tenant}/namespaces | Create a namespace
*NamespacesApi* | [**delete_namespace**](docs/NamespacesApi.md#delete_namespace) | **DELETE** /api/v1/{tenant}/namespaces/{id} | Delete a namespace
*NamespacesApi* | [**delete_secret**](docs/NamespacesApi.md#delete_secret) | **DELETE** /api/v1/{tenant}/namespaces/{namespace}/secrets/{key} | Delete a secret for a namespace
*NamespacesApi* | [**get_inherited_secrets**](docs/NamespacesApi.