@kestra-io/kestra_api_client

All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.
Endpoints designated as Superadmin-only are not tenant-scoped.

This Python package is automatically generated by the OpenAPI Generator 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:

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:

import kestra_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kestra_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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 POST /api/v1/{tenant}/ai/generate/flow Generate or regenerate a flow based on a prompt
AppsApi bulk_delete_apps DELETE /api/v1/{tenant}/apps Delete existing apps
AppsApi bulk_disable_apps POST /api/v1/{tenant}/apps/disable Disable existing apps
AppsApi bulk_enable_apps POST /api/v1/{tenant}/apps/enable Enable existing apps
AppsApi bulk_export_apps POST /api/v1/{tenant}/apps/export Export apps as a ZIP archive of YAML sources.
AppsApi create_app POST /api/v1/{tenant}/apps Create a new app
AppsApi delete_app DELETE /api/v1/{tenant}/apps/{uid} Delete an existing app
AppsApi disable_app POST /api/v1/{tenant}/apps/{uid}/disable Disable the app.
AppsApi dispatch_app POST /api/v1/{tenant}/apps/view/{id}/dispatch/{dispatch} Dispatch for a given app.
AppsApi download_file_from_app_execution GET /api/v1/{tenant}/apps/view/{id}/file/download Download file from an app execution
AppsApi enable_app POST /api/v1/{tenant}/apps/{uid}/enable Enable the app.
AppsApi get_app GET /api/v1/{tenant}/apps/{uid} Retrieve an app
AppsApi 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 GET /api/v1/{tenant}/apps/view/{id}/file/preview Get file preview from an app execution
AppsApi 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 GET /api/v1/{tenant}/apps/view/{id}/streams/{stream} Get an event stream from a given app.
AppsApi list_tags GET /api/v1/{tenant}/apps/tags Get all the app tags
AppsApi open_app GET /api/v1/{tenant}/apps/view/{uid} Open an app
AppsApi preview_app POST /api/v1/{tenant}/apps/preview Open the app for the given source
AppsApi search_apps GET /api/v1/{tenant}/apps/search Search for apps
AppsApi search_apps_from_catalog GET /api/v1/{tenant}/apps/catalog Search for apps from catalog
AppsApi update_app PUT /api/v1/{tenant}/apps/{uid} Update an existing app
AuditLogsApi export_audit_logs GET /api/v1/{tenant}/auditlogs/export Export all audit logs as a streamed CSV file
AuditLogsApi find_audit_log POST /api/v1/{tenant}/auditlogs/find Find a specific audit log
AuditLogsApi 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 GET /api/v1/{tenant}/auditlogs/{id}/diff Retrieve the diff between audit logs
AuditLogsApi 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 GET /api/v1/{tenant}/auditlogs/search Search for audit logs
AuditLogsApi 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 POST /api/v1/me/api-tokens Create API token for the authenticated user
AuthsApi delete_api_token_for_current_user DELETE /api/v1/me/api-tokens/{tokenId} Delete API token for the authenticated user
AuthsApi get_current_user GET /api/v1/me Get details about the authenticated user
AuthsApi index GET /api/v1/auths Retrieve list of authentication methods
AuthsApi list_api_tokens_for_current_user GET /api/v1/me/api-tokens List API tokens for authenticated user
AuthsApi patch_current_user PATCH /api/v1/me Update authenticated user details
BannersApi create_banner POST /api/v1/banners Create an announcement banner
BannersApi delete_banner DELETE /api/v1/banners/{id} Delete an announcement banner
BannersApi search_banners GET /api/v1/banners/search Retrieve all announcement banners
BannersApi update_banner PUT /api/v1/banners/{id} Update an announcement banner
BindingsApi bulk_create_binding POST /api/v1/{tenant}/bindings/bulk Create multiple bindings
BindingsApi create_binding POST /api/v1/{tenant}/bindings Create a binding
BindingsApi delete_binding DELETE /api/v1/{tenant}/bindings/{id} Delete a binding
BindingsApi get_binding GET /api/v1/{tenant}/bindings/{id} Retrieve a binding
BindingsApi search_bindings GET /api/v1/{tenant}/bindings/search Search for bindings
BlueprintTagsApi internal_blueprint_tags GET /api/v1/{tenant}/blueprints/custom/tags List all internal blueprint tags
BlueprintTagsApi list_blueprint_tags GET /api/v1/{tenant}/blueprints/community/{kind}/tags List blueprint tags matching the filter
BlueprintsApi create_internal_blueprints POST /api/v1/{tenant}/blueprints/custom Create a new internal blueprint
BlueprintsApi delete_internal_blueprints DELETE /api/v1/{tenant}/blueprints/custom/{id} Delete an internal blueprint
BlueprintsApi get_blueprint GET /api/v1/{tenant}/blueprints/community/{kind}/{id} Retrieve a blueprint
BlueprintsApi get_blueprint_graph GET /api/v1/{tenant}/blueprints/community/{kind}/{id}/graph Retrieve a blueprint graph
BlueprintsApi get_blueprint_source GET /api/v1/{tenant}/blueprints/community/{kind}/{id}/source Retrieve a blueprint source code
BlueprintsApi internal_blueprint GET /api/v1/{tenant}/blueprints/custom/{id} Retrieve an internal blueprint
BlueprintsApi internal_blueprint_flow GET /api/v1/{tenant}/blueprints/custom/{id}/source Retrieve an internal blueprint source code
BlueprintsApi search_blueprints GET /api/v1/{tenant}/blueprints/community/{kind} List all blueprints
BlueprintsApi search_internal_blueprints GET /api/v1/{tenant}/blueprints/custom List all internal blueprints
BlueprintsApi update_internal_blueprints PUT /api/v1/{tenant}/blueprints/custom/{id} Update an internal blueprint
ClusterApi enter_maintenance POST /api/v1/instance/maintenance/enter Enter cluster maintenance mode
ClusterApi exit_maintenance POST /api/v1/instance/maintenance/exit Exit cluster maintenance mode
DashboardsApi create_dashboard POST /api/v1/{tenant}/dashboards Create a dashboard from yaml source
DashboardsApi delete_dashboard DELETE /api/v1/{tenant}/dashboards/{id} Delete a dashboard
DashboardsApi 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 POST /api/v1/{tenant}/dashboards/{id}/charts/{chartId}/export/to-csv Export a dashboard chart data to CSV
DashboardsApi get_dashboard GET /api/v1/{tenant}/dashboards/{id} Get a dashboard
DashboardsApi get_dashboard_chart_data POST /api/v1/{tenant}/dashboards/{id}/charts/{chartId} Generate a dashboard chart data
DashboardsApi preview_chart POST /api/v1/{tenant}/dashboards/charts/preview Preview a chart data
DashboardsApi search_dashboards GET /api/v1/{tenant}/dashboards Search for dashboards
DashboardsApi update_dashboard PUT /api/v1/{tenant}/dashboards/{id} Update a dashboard
DashboardsApi validate_chart POST /api/v1/{tenant}/dashboards/validate/chart Validate a chart from yaml source
DashboardsApi validate_dashboard POST /api/v1/{tenant}/dashboards/validate Validate dashboard from yaml source
ExecutionsApi create_execution POST /api/v1/{tenant}/executions/{namespace}/{id} Create a new execution for a flow
ExecutionsApi delete_execution DELETE /api/v1/{tenant}/executions/{executionId} Delete an execution
ExecutionsApi delete_executions_by_ids DELETE /api/v1/{tenant}/executions/by-ids Delete a list of executions
ExecutionsApi delete_executions_by_query DELETE /api/v1/{tenant}/executions/by-query Delete executions filter by query parameters
ExecutionsApi download_file_from_execution GET /api/v1/{tenant}/executions/{executionId}/file Download file for an execution
ExecutionsApi eval_task_run_expression POST /api/v1/{tenant}/executions/{executionId}/eval/{taskRunId} Evaluate a variable expression for this taskrun
ExecutionsApi follow_dependencies_executions GET /api/v1/{tenant}/executions/{executionId}/follow-dependencies Follow all execution dependencies executions
ExecutionsApi follow_execution GET /api/v1/{tenant}/executions/{executionId}/follow Follow an execution
ExecutionsApi force_run_by_ids POST /api/v1/{tenant}/executions/force-run/by-ids Force run a list of executions
ExecutionsApi force_run_execution POST /api/v1/{tenant}/executions/{executionId}/force-run Force run an execution
ExecutionsApi force_run_executions_by_query POST /api/v1/{tenant}/executions/force-run/by-query Force run executions filter by query parameters
ExecutionsApi get_execution GET /api/v1/{tenant}/executions/{executionId} Get an execution
ExecutionsApi get_execution_flow_graph GET /api/v1/{tenant}/executions/{executionId}/graph Generate a graph for an execution
ExecutionsApi 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 GET /api/v1/{tenant}/executions/flows/{namespace}/{flowId} Get flow information's for an execution
ExecutionsApi get_flow_from_execution_by_id GET /api/v1/{tenant}/executions/{executionId}/flow Get flow information's for an execution
ExecutionsApi get_latest_executions POST /api/v1/{tenant}/executions/latest Get the latest execution for given flows
ExecutionsApi kill_execution DELETE /api/v1/{tenant}/executions/{executionId}/kill Kill an execution
ExecutionsApi kill_executions_by_ids DELETE /api/v1/{tenant}/executions/kill/by-ids Kill a list of executions
ExecutionsApi kill_executions_by_query DELETE /api/v1/{tenant}/executions/kill/by-query Kill executions filter by query parameters
ExecutionsApi list_executable_distinct_namespaces GET /api/v1/{tenant}/executions/namespaces Get all namespaces that have executable flows
ExecutionsApi 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 POST /api/v1/{tenant}/executions/{executionId}/pause Pause a running execution.
ExecutionsApi pause_executions_by_ids POST /api/v1/{tenant}/executions/pause/by-ids Pause a list of running executions
ExecutionsApi pause_executions_by_query POST /api/v1/{tenant}/executions/pause/by-query Pause executions filter by query parameters
ExecutionsApi preview_file_from_execution GET /api/v1/{tenant}/executions/{executionId}/file/preview Get file preview for an execution
ExecutionsApi 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 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 POST /api/v1/{tenant}/executions/replay/by-ids Create new executions from old ones. Keep the flow revision
ExecutionsApi 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 POST /api/v1/{tenant}/executions/{executionId}/restart Restart a new execution from an old one
ExecutionsApi restart_executions_by_ids POST /api/v1/{tenant}/executions/restart/by-ids Restart a list of executions
ExecutionsApi restart_executions_by_query POST /api/v1/{tenant}/executions/restart/by-query Restart executions filter by query parameters
ExecutionsApi resume_execution POST /api/v1/{tenant}/executions/{executionId}/resume Resume a paused execution.
ExecutionsApi resume_execution_from_breakpoint POST /api/v1/{tenant}/executions/{executionId}/resume-from-breakpoint Resume an execution from a breakpoint (in the 'BREAKPOINT' state).
ExecutionsApi resume_executions_by_ids POST /api/v1/{tenant}/executions/resume/by-ids Resume a list of paused executions
ExecutionsApi resume_executions_by_query POST /api/v1/{tenant}/executions/resume/by-query Resume executions filter by query parameters
ExecutionsApi search_executions GET /api/v1/{tenant}/executions/search Search for executions
ExecutionsApi search_executions_by_flow_id GET /api/v1/{tenant}/executions Search for executions for a flow
ExecutionsApi search_task_run GET /api/v1/{tenant}/taskruns/search Search for taskruns, only available with the Elasticsearch repository
ExecutionsApi 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 POST /api/v1/{tenant}/executions/labels/by-ids Set labels on a list of executions
ExecutionsApi 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 POST /api/v1/{tenant}/executions/trigger/{namespace}/{id} Trigger a new execution for a flow
ExecutionsApi 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 POST /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key} Trigger a new execution by POST webhook trigger
ExecutionsApi 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 POST /api/v1/{tenant}/executions/{executionId}/unqueue Unqueue an execution
ExecutionsApi unqueue_executions_by_ids POST /api/v1/{tenant}/executions/unqueue/by-ids Unqueue a list of executions
ExecutionsApi unqueue_executions_by_query POST /api/v1/{tenant}/executions/unqueue/by-query Unqueue executions filter by query parameters
ExecutionsApi update_execution_status POST /api/v1/{tenant}/executions/{executionId}/change-status Change the state of an execution
ExecutionsApi 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 POST /api/v1/{tenant}/executions/change-status/by-query Change executions state by query parameters
ExecutionsApi update_task_run_state POST /api/v1/{tenant}/executions/{executionId}/state Change state for a taskrun in an execution
ExecutionsApi 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 POST /api/v1/{tenant}/executions/{executionId}/resume/validate Validate inputs to resume a paused execution.
FilesApi create_namespace_directory POST /api/v1/{tenant}/namespaces/{namespace}/files/directory Create a directory
FilesApi create_namespace_file POST /api/v1/{tenant}/namespaces/{namespace}/files Create a file
FilesApi delete_file_directory DELETE /api/v1/{tenant}/namespaces/{namespace}/files Delete a file or directory
FilesApi export_namespace_files GET /api/v1/{tenant}/namespaces/{namespace}/files/export Export namespace files as a ZIP
FilesApi get_file_content GET /api/v1/{tenant}/namespaces/{namespace}/files Get namespace file content
FilesApi get_file_metadatas GET /api/v1/{tenant}/namespaces/{namespace}/files/stats Get namespace file stats such as size, creation & modification dates and type
FilesApi list_namespace_directory_files GET /api/v1/{tenant}/namespaces/{namespace}/files/directory List directory content
FilesApi move_file_directory PUT /api/v1/{tenant}/namespaces/{namespace}/files Move a file or directory
FilesApi 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 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't be imported is returned.
FlowsApi bulk_update_flows POST /api/v1/{tenant}/flows/bulk Update from multiples yaml sources
FlowsApi create_flow POST /api/v1/{tenant}/flows Create a flow from yaml source
FlowsApi delete_flow DELETE /api/v1/{tenant}/flows/{namespace}/{id} Delete a flow
FlowsApi delete_flows_by_ids DELETE /api/v1/{tenant}/flows/delete/by-ids Delete flows by their IDs.
FlowsApi delete_flows_by_query DELETE /api/v1/{tenant}/flows/delete/by-query Delete flows returned by the query parameters.
FlowsApi disable_flows_by_ids POST /api/v1/{tenant}/flows/disable/by-ids Disable flows by their IDs.
FlowsApi disable_flows_by_query POST /api/v1/{tenant}/flows/disable/by-query Disable flows returned by the query parameters.
FlowsApi enable_flows_by_ids POST /api/v1/{tenant}/flows/enable/by-ids Enable flows by their IDs.
FlowsApi enable_flows_by_query POST /api/v1/{tenant}/flows/enable/by-query Enable flows returned by the query parameters.
FlowsApi 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 GET /api/v1/{tenant}/flows/export/by-query Export flows as a ZIP archive of yaml sources.
FlowsApi generate_flow_graph GET /api/v1/{tenant}/flows/{namespace}/{id}/graph Generate a graph for a flow
FlowsApi generate_flow_graph_from_source POST /api/v1/{tenant}/flows/graph Generate a graph for a flow source
FlowsApi get_flow GET /api/v1/{tenant}/flows/{namespace}/{id} Get a flow
FlowsApi get_flow_dependencies GET /api/v1/{tenant}/flows/{namespace}/{id}/dependencies Get flow dependencies
FlowsApi get_flow_dependencies_from_namespace GET /api/v1/{tenant}/namespaces/{namespace}/dependencies Retrieve flow dependencies
FlowsApi get_task_from_flow GET /api/v1/{tenant}/flows/{namespace}/{id}/tasks/{taskId} Get a flow task
FlowsApi 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't be imported is returned.
FlowsApi list_distinct_namespaces GET /api/v1/{tenant}/flows/distinct-namespaces List all distinct namespaces
FlowsApi list_flow_revisions GET /api/v1/{tenant}/flows/{namespace}/{id}/revisions Get revisions for a flow
FlowsApi list_flows_by_namespace GET /api/v1/{tenant}/flows/{namespace} Retrieve all flows from a given namespace
FlowsApi search_flows GET /api/v1/{tenant}/flows/search Search for flows
FlowsApi search_flows_by_source_code GET /api/v1/{tenant}/flows/source Search for flows source code
FlowsApi update_flow PUT /api/v1/{tenant}/flows/{namespace}/{id} Update a flow
FlowsApi update_flows_in_namespace_from_json POST /api/v1/{tenant}/flows/{namespace} Update a complete namespace from json object
FlowsApi update_task PATCH /api/v1/{tenant}/flows/{namespace}/{id}/{taskId} Update a single task on a flow
FlowsApi validate_flows POST /api/v1/{tenant}/flows/validate Validate a list of flows
FlowsApi validate_task POST /api/v1/{tenant}/flows/validate/task Validate a task
FlowsApi validate_trigger POST /api/v1/{tenant}/flows/validate/trigger Validate trigger
GroupsApi add_user_to_group PUT /api/v1/{tenant}/groups/{id}/members/{userId} Add a user to a group
GroupsApi autocomplete_groups POST /api/v1/{tenant}/groups/autocomplete List groups for autocomplete
GroupsApi create_group POST /api/v1/{tenant}/groups Create a group
GroupsApi delete_group DELETE /api/v1/{tenant}/groups/{id} Delete a group
GroupsApi delete_user_from_group DELETE /api/v1/{tenant}/groups/{id}/members/{userId} Remove a user from a group
GroupsApi get_group GET /api/v1/{tenant}/groups/{id} Retrieve a group
GroupsApi list_group_ids POST /api/v1/{tenant}/groups/ids List groups by ids
GroupsApi search_group_members GET /api/v1/{tenant}/groups/{id}/members Search for users in a group
GroupsApi search_groups GET /api/v1/{tenant}/groups/search Search for groups
GroupsApi set_user_membership_for_group PUT /api/v1/{tenant}/groups/{id}/members/membership/{userId} Update a user's membership type in a group
GroupsApi update_group PUT /api/v1/{tenant}/groups/{id} Update a group
InvitationsApi create_invitation POST /api/v1/{tenant}/invitations Create an invitation
InvitationsApi delete_invitation DELETE /api/v1/{tenant}/invitations/{id} Delete an invitation
InvitationsApi find_all_invitations_for_current_user GET /api/v1/me/invitations List invitations for the authenticated user
InvitationsApi get_invitation GET /api/v1/{tenant}/invitations/{id} Retrieve an invitation
InvitationsApi list_invitations_by_email GET /api/v1/{tenant}/invitations/email/{email} Retrieve all invitations for a given email
InvitationsApi search_invitations GET /api/v1/{tenant}/invitations/search Search for invitations
KVApi delete_key_value DELETE /api/v1/{tenant}/namespaces/{namespace}/kv/{key} Delete a key-value pair
KVApi delete_key_values DELETE /api/v1/{tenant}/namespaces/{namespace}/kv Bulk-delete multiple key/value pairs from the given namespace.
KVApi get_key_value GET /api/v1/{tenant}/namespaces/{namespace}/kv/{key} Get value for a key
KVApi list_keys GET /api/v1/{tenant}/namespaces/{namespace}/kv List all keys for a namespace
KVApi 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 PUT /api/v1/{tenant}/namespaces/{namespace}/kv/{key} Puts a key-value pair in store
LogsApi delete_logs_from_execution DELETE /api/v1/{tenant}/logs/{executionId} Delete logs for a specific execution, taskrun or task
LogsApi 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 GET /api/v1/{tenant}/logs/{executionId}/download Download logs for a specific execution, taskrun or task
LogsApi follow_logs_from_execution GET /api/v1/{tenant}/logs/{executionId}/follow Follow logs for a specific execution
LogsApi list_logs_from_execution GET /api/v1/{tenant}/logs/{executionId} Get logs for a specific execution, taskrun or task
LogsApi search_logs GET /api/v1/{tenant}/logs/search Search for logs
MaintenanceApi enter_maintenance POST /api/v1/instance/maintenance/enter Enter cluster maintenance mode
MaintenanceApi exit_maintenance POST /api/v1/instance/maintenance/exit Exit cluster maintenance mode
MetricsApi 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 GET /api/v1/{tenant}/metrics/aggregates/{namespace}/{flowId}/{taskId}/{metric} Get metrics aggregations for a specific flow
MetricsApi list_flow_metrics GET /api/v1/{tenant}/metrics/names/{namespace}/{flowId} Get metrics names for a specific flow
MetricsApi 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 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 GET /api/v1/{tenant}/metrics/{executionId} Get metrics for a specific execution
MiscApi create_basic_auth POST /api/v1/{tenant}/basicAuth Configure basic authentication for the instance.
MiscApi get_basic_auth_config_errors GET /api/v1/basicAuthValidationErrors Retrieve the instance configuration.
MiscApi get_configuration GET /api/v1/configs Retrieve the instance configuration.
MiscApi get_usages GET /api/v1/{tenant}/usages/all Retrieve instance usage information
MiscApi license_info GET /api/v1/license-info Retrieve license information
MiscApi list_actions GET /api/v1/{tenant}/acls/actions Retrieve list of actions
MiscApi list_permissions GET /api/v1/{tenant}/acls/permissions Retrieve list of permissions
MiscApi setup_configuration GET /api/v1/setup Retrieve current setup configuration
MiscApi setup_kestra POST /api/v1/setup Create the first Superadmin user
MiscApi tenant_usage GET /api/v1/{tenant}/usages Retrieve usage information for the current tenant
NamespacesApi autocomplete_namespaces POST /api/v1/{tenant}/namespaces/autocomplete List namespaces for autocomplete
NamespacesApi create_namespace POST /api/v1/{tenant}/namespaces Create a namespace
NamespacesApi delete_namespace DELETE /api/v1/{tenant}/namespaces/{id} Delete a namespace
NamespacesApi delete_secret DELETE /api/v1/{tenant}/namespaces/{namespace}/secrets/{key} Delete a secret for a namespace
NamespacesApi get_inherited_secrets GET /api/v1/{tenant}/namespaces/{namespace}/inherited-secrets List inherited secrets
NamespacesApi get_namespace GET /api/v1/{tenant}/namespaces/{id} Get a namespace
NamespacesApi inherited_plugin_defaults GET /api/v1/{tenant}/namespaces/{id}/inherited-plugindefaults List inherited plugin defaults
NamespacesApi inherited_variables GET /api/v1/{tenant}/namespaces/{id}/inherited-variables List inherited variables
NamespacesApi list_namespace_secrets GET /api/v1/{tenant}/namespaces/{namespace}/secrets Get secrets for a namespace
NamespacesApi patch_secret PATCH /api/v1/{tenant}/namespaces/{namespace}/secrets/{key} Patch a secret metadata for a namespace
NamespacesApi put_secrets PUT /api/v1/{tenant}/namespaces/{namespace}/secrets Update secrets for a namespace
NamespacesApi search_namespaces GET /api/v1/{tenant}/namespaces/search Search for namespaces
NamespacesApi update_namespace PUT /api/v1/{tenant}/namespaces/{id} Update a namespace
PluginsApi get_all_input_types GET /api/v1/plugins/inputs Get all types for an inputs
PluginsApi get_plugin_by_subgroups GET /api/v1/plugins/groups/subgroups Get plugins group by subgroups
PluginsApi get_plugin_documentation GET /api/v1/plugins/{cls} Get plugin documentation
PluginsApi get_plugin_documentation_from_version GET /api/v1/plugins/{cls}/versions/{version} Get plugin documentation
PluginsApi get_plugin_group_icons GET /api/v1/plugins/icons/groups Get plugins icons
PluginsApi get_plugin_icons GET /api/v1/plugins/icons Get plugins icons
PluginsApi get_plugin_versions GET /api/v1/plugins/{cls}/versions Get all versions for a plugin
PluginsApi get_properties_from_type GET /api/v1/plugins/properties/{type} Get the properties part of the JSON schema for a type
PluginsApi get_schema_from_input_type GET /api/v1/plugins/inputs/{type} Get the JSON schema for an input type
PluginsApi get_schemas_from_type GET /api/v1/plugins/schemas/{type} Get the JSON schema for a type
PluginsApi get_versioned_plugin_details GET /api/v1/instance/versioned-plugins/{groupId}/{artifactId} Retrieve details of a plugin artifact
PluginsApi get_versioned_plugin_details_from_version GET /api/v1/instance/versioned-plugins/{groupId}/{artifactId}/{version} Retrieve details of a specific plugin artifact version
PluginsApi install_versioned_plugins POST /api/v1/instance/versioned-plugins/install Install specified plugin artifacts
PluginsApi list_available_versioned_plugins GET /api/v1/instance/versioned-plugins/available List available plugin artifacts
PluginsApi list_available_versioned_plugins_for_secret_manager GET /api/v1/instance/versioned-plugins/available/secrets-managers List available plugin artifacts for Kestra Secret Manager
PluginsApi list_available_versioned_plugins_for_storage GET /api/v1/instance/versioned-plugins/available/storages List available plugin artifacts for Kestra Internal Storage
PluginsApi list_plugins GET /api/v1/plugins Get list of plugins
PluginsApi list_versioned_plugin GET /api/v1/instance/versioned-plugins List installed plugin artifacts
PluginsApi resolve_versioned_plugins POST /api/v1/instance/versioned-plugins/resolve Resolve versions for specified plugin artifacts
PluginsApi uninstall_versioned_plugins DELETE /api/v1/instance/versioned-plugins/uninstall Uninstall plugin artifacts
PluginsApi upload_versioned_plugins POST /api/v1/instance/versioned-plugins/upload Upload a plugin artifact JAR file
RolesApi autocomplete_roles POST /api/v1/{tenant}/roles/autocomplete List roles for autocomplete
RolesApi create_role POST /api/v1/{tenant}/roles Create a role
RolesApi delete_role DELETE /api/v1/{tenant}/roles/{id} Delete a role
RolesApi get_role GET /api/v1/{tenant}/roles/{id} Retrieve a role
RolesApi list_roles_from_given_ids POST /api/v1/{tenant}/roles/ids List roles by ids
RolesApi search_roles GET /api/v1/{tenant}/roles/search Search for roles
RolesApi update_role PUT /api/v1/{tenant}/roles/{id} Update a role
SCIMConfigurationApi get_all_resource_types GET /api/v1/{tenant}/integrations/{integration}/scim/v2/ResourceTypes
SCIMConfigurationApi get_all_schemas GET /api/v1/{tenant}/integrations/{integration}/scim/v2/Schemas
SCIMConfigurationApi get_resource_type GET /api/v1/{tenant}/integrations/{integration}/scim/v2/ResourceTypes/{name}
SCIMConfigurationApi get_schema GET /api/v1/{tenant}/integrations/{integration}/scim/v2/Schemas/{uri}
SCIMConfigurationApi get_service_provider_configuration GET /api/v1/{tenant}/integrations/{integration}/scim/v2/ServiceProviderConfig
SCIMGroupsApi create_scim_resource_by_id_groups POST /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups
SCIMGroupsApi delete_groups DELETE /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/{id}
SCIMGroupsApi find_groups POST /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/.search
SCIMGroupsApi get_scim_resource_by_id_groups GET /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/{id}
SCIMGroupsApi patch_groups PATCH /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/{id}
SCIMGroupsApi query_groups GET /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups
SCIMGroupsApi update_groups PUT /api/v1/{tenant}/integrations/{integration}/scim/v2/Groups/{id}
SCIMUsersApi create_scim_resource_by_id_users POST /api/v1/{tenant}/integrations/{integration}/scim/v2/Users
SCIMUsersApi delete_users DELETE /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/{id}
SCIMUsersApi find_users POST /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/.search
SCIMUsersApi get_scim_resource_by_id_users GET /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/{id}
SCIMUsersApi patch_users PATCH /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/{id}
SCIMUsersApi query_users GET /api/v1/{tenant}/integrations/{integration}/scim/v2/Users
SCIMUsersApi update_users PUT /api/v1/{tenant}/integrations/{integration}/scim/v2/Users/{id}
SecurityIntegrationsApi create_security_integration POST /api/v1/{tenant}/security-integrations Create a security integration
SecurityIntegrationsApi delete_security_integration DELETE /api/v1/{tenant}/security-integrations/{id} Delete a security integration
SecurityIntegrationsApi disable_security_integration POST /api/v1/{tenant}/security-integrations/{id}/disable Disable a security integration
SecurityIntegrationsApi enable_security_integration POST /api/v1/{tenant}/security-integrations/{id}/enable Enable a security integration
SecurityIntegrationsApi get_security_integration GET /api/v1/{tenant}/security-integrations/{id} Retrieve a security integration
SecurityIntegrationsApi list_security_integrations GET /api/v1/{tenant}/security-integrations List all security integrations
ServiceAccountApi create_service_account POST /api/v1/service-accounts Create a service account
ServiceAccountApi create_service_account_for_tenant POST /api/v1/{tenant}/service-accounts Create a service account for the given tenant
ServiceAccountApi delete_service_account DELETE /api/v1/service-accounts/{id} Delete a service account
ServiceAccountApi delete_service_account_for_tenant DELETE /api/v1/{tenant}/service-accounts/{id} Delete a service account
ServiceAccountApi get_service_account GET /api/v1/service-accounts/{id} Get a service account
ServiceAccountApi get_service_account_for_tenant GET /api/v1/{tenant}/service-accounts/{id} Retrieve a service account
ServiceAccountApi list_service_accounts GET /api/v1/service-accounts List service accounts. Superadmin-only.
ServiceAccountApi patch_service_account_details PATCH /api/v1/service-accounts/{id} Update service account details
ServiceAccountApi patch_service_account_super_admin PATCH /api/v1/service-accounts/{id}/superadmin Update service account superadmin privileges
ServiceAccountApi update_service_account PUT /api/v1/{tenant}/service-accounts/{id} Update a user service account
ServicesApi get_active_services GET /api/v1/instance/services/active List all active services
ServicesApi get_service GET /api/v1/instance/services/{id} Retrieve details of a specific service
ServicesApi search_services GET /api/v1/instance/services/search Search for a service (e.g. Worker, Executor, etc)
TenantAccessApi create_tenant_access POST /api/v1/{tenant}/tenant-access Create tenant access for a user
TenantAccessApi create_tenant_access1 PUT /api/v1/{tenant}/tenant-access/{userId} Create tenant access for a user
TenantAccessApi delete_tenant_access DELETE /api/v1/{tenant}/tenant-access/{userId} Delete tenant access for a user
TenantAccessApi get_tenant_access GET /api/v1/{tenant}/tenant-access/{userId} Retrieve tenant access for a user
TenantAccessApi list_tenant_access GET /api/v1/{tenant}/tenant-access Retrieve users belonging to the tenant
TenantsApi create POST /api/v1/tenants Create a tenant
TenantsApi delete DELETE /api/v1/tenants/{id} Delete a tenant and all its resources
TenantsApi find GET /api/v1/tenants/search Search for tenants
TenantsApi get GET /api/v1/tenants/{id} Retrieve a tenant
TenantsApi get_flow_dependencies_from_tenant GET /api/v1/{tenant}/dependencies Get tenant dependencies
TenantsApi set_logo POST /api/v1/tenants/{id}/logo Set a tenant logo
TenantsApi update PUT /api/v1/tenants/{id} Update a tenant
TestSuitesApi create_test_suite POST /api/v1/{tenant}/tests Create a test from YAML source
TestSuitesApi delete_test_suite DELETE /api/v1/{tenant}/tests/{namespace}/{id} Delete a test
TestSuitesApi delete_test_suites_by_ids DELETE /api/v1/{tenant}/tests/by-ids Delete multiple tests by id
TestSuitesApi disable_test_suites_by_ids POST /api/v1/{tenant}/tests/disable/by-ids Disable multiple tests by id
TestSuitesApi enable_test_suites_by_ids POST /api/v1/{tenant}/tests/enable/by-ids Enable multiple tests by id
TestSuitesApi get_test_result GET /api/v1/{tenant}/tests/results/{id} Get a test result
TestSuitesApi get_test_suite GET /api/v1/{tenant}/tests/{namespace}/{id} Retrieve a test
TestSuitesApi get_tests_last_result POST /api/v1/{tenant}/tests/results/search/last Get tests last result
TestSuitesApi run_test_suite POST /api/v1/{tenant}/tests/{namespace}/{id}/run Run a full test
TestSuitesApi run_test_suites_by_query POST /api/v1/{tenant}/tests/run Run multiple TestSuites by query
TestSuitesApi search_test_suites GET /api/v1/{tenant}/tests/search Search for tests
TestSuitesApi search_test_suites_results GET /api/v1/{tenant}/tests/results/search Search for tests results
TestSuitesApi update_test_suite PUT /api/v1/{tenant}/tests/{namespace}/{id} Update a test from YAML source
TestSuitesApi validate_test_suite POST /api/v1/{tenant}/tests/validate Validate a test
TriggersApi delete_backfill POST /api/v1/{tenant}/triggers/backfill/delete Delete a backfill
TriggersApi delete_backfill_by_ids POST /api/v1/{tenant}/triggers/backfill/delete/by-triggers Delete backfill for given triggers
TriggersApi delete_backfill_by_query POST /api/v1/{tenant}/triggers/backfill/delete/by-query Delete backfill for given triggers
TriggersApi disabled_triggers_by_ids POST /api/v1/{tenant}/triggers/set-disabled/by-triggers Disable/enable given triggers
TriggersApi disabled_triggers_by_query POST /api/v1/{tenant}/triggers/set-disabled/by-query Disable/enable triggers by query parameters
TriggersApi pause_backfill PUT /api/v1/{tenant}/triggers/backfill/pause Pause a backfill
TriggersApi pause_backfill_by_ids POST /api/v1/{tenant}/triggers/backfill/pause/by-triggers Pause backfill for given triggers
TriggersApi pause_backfill_by_query POST /api/v1/{tenant}/triggers/backfill/pause/by-query Pause backfill for given triggers
TriggersApi restart_trigger POST /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}/restart Restart a trigger
TriggersApi search_triggers GET /api/v1/{tenant}/triggers/search Search for triggers
TriggersApi search_triggers_for_flow GET /api/v1/{tenant}/triggers/{namespace}/{flowId} Get all triggers for a flow
TriggersApi unlock_trigger POST /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId}/unlock Unlock a trigger
TriggersApi unlock_triggers_by_ids POST /api/v1/{tenant}/triggers/unlock/by-triggers Unlock given triggers
TriggersApi unlock_triggers_by_query POST /api/v1/{tenant}/triggers/unlock/by-query Unlock triggers by query parameters
TriggersApi unpause_backfill PUT /api/v1/{tenant}/triggers/backfill/unpause Unpause a backfill
TriggersApi unpause_backfill_by_ids POST /api/v1/{tenant}/triggers/backfill/unpause/by-triggers Unpause backfill for given triggers
TriggersApi unpause_backfill_by_query POST /api/v1/{tenant}/triggers/backfill/unpause/by-query Unpause backfill for given triggers
TriggersApi update_trigger PUT /api/v1/{tenant}/triggers Update a trigger
UsersApi autocomplete_users POST /api/v1/{tenant}/tenant-access/autocomplete List users for autocomplete
UsersApi create_api_tokens_for_user POST /api/v1/service-accounts/{id}/api-tokens Create new API Token for a specific user
UsersApi create_api_tokens_for_user1 POST /api/v1/users/{id}/api-tokens Create new API Token for a specific user
UsersApi create_api_tokens_for_user_with_tenant POST /api/v1/{tenant}/service-accounts/{id}/api-tokens Create new API Token for a specific user
UsersApi create_user POST /api/v1/users Create a new user account
UsersApi delete_api_token DELETE /api/v1/service-accounts/{id}/api-tokens/{tokenId} Delete an API Token for specific user and token id
UsersApi delete_api_token1 DELETE /api/v1/users/{id}/api-tokens/{tokenId} Delete an API Token for specific user and token id
UsersApi delete_api_token_with_tenant DELETE /api/v1/{tenant}/service-accounts/{id}/api-tokens/{tokenId} Delete an API Token for specific user and token id
UsersApi delete_refresh_token DELETE /api/v1/users/{id}/refresh-token Delete a user refresh token
UsersApi delete_user DELETE /api/v1/users/{id} Delete a user
UsersApi delete_user_auth_method DELETE /api/v1/users/{id}/auths/{auth} Update user password
UsersApi get_user GET /api/v1/users/{id} Get a user
UsersApi impersonate POST /api/v1/users/{id}/impersonate Impersonate a user
UsersApi list_api_tokens GET /api/v1/service-accounts/{id}/api-tokens List API tokens for a specific user
UsersApi list_api_tokens1 GET /api/v1/users/{id}/api-tokens List API tokens for a specific user
UsersApi list_api_tokens_with_tenant GET /api/v1/{tenant}/service-accounts/{id}/api-tokens List API tokens for a specific user
UsersApi list_users GET /api/v1/users Retrieve users
UsersApi patch_user PATCH /api/v1/users/{id} Update user details
UsersApi patch_user_demo PATCH /api/v1/users/{id}/restricted Update user demo
UsersApi patch_user_password PATCH /api/v1/users/{id}/password Update user password
UsersApi patch_user_super_admin PATCH /api/v1/users/{id}/superadmin Update user superadmin privileges
UsersApi update_current_user_password PUT /api/v1/me/password Update authenticated user password
UsersApi update_user PUT /api/v1/users/{id} Update a user account
UsersApi update_user_groups PUT /api/v1/{tenant}/users/{id}/groups Update the list of groups a user belongs to for the given tenant
WorkerGroupsApi create_worker_group POST /api/v1/instance/workergroups Create a worker group
WorkerGroupsApi delete_worker_group_by_id DELETE /api/v1/instance/workergroups/{id} Delete a worker group
WorkerGroupsApi get_worker_group_by_id GET /api/v1/instance/workergroups/{id} Retrieve details of a specific worker group
WorkerGroupsApi list_worker_groups GET /api/v1/instance/workergroups List all worker groups
WorkerGroupsApi update_worker_group_by_id PUT /api/v1/instance/workergroups/{id} Update a worker group
DefaultApi accept_invitation POST /api/v1/invitation/accept/{invitationId}
DefaultApi create_from_invitation POST /api/v1/invitation/create/{invitationId}
DefaultApi forgotten_password GET /api/v1/forgotten-password Sends an email to reset a password.
DefaultApi generate GET /api/v1/{tenant}/stats/generate-reports
DefaultApi login POST /login
DefaultApi reset_password POST /api/v1/reset-password Change a password for given token.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

bearerAuth

  • Type: Bearer authentication (Bearer)

Author

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Kestra from gravatar.com Kestra

Credits

Author: Kestra.io

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Kestra EE

Report project as malware

Release files for kestra-api-client 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kestra-api-client 1.0.0
File Size Uploaded
kestra_api_client-1.0.0.tar.gz 308.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kestra-api-client 1.0.0
File Interpreter ABI Platform
kestra_api_client-1.0.0-py3-none-any.whl 840.2 kB Python 3 none any Details

Total release size: 1.1 MB

Release files / kestra_api_client-1.0.0.tar.gz

Download URL kestra_api_client-1.0.0.tar.gz
Size 308.8 kB
Tags Source
SHA-256 checksum
How to use checksums 		c061a6760f74e88051e84d53fb5175740ad7bb0f28600b67f5d055a602676bce
BLAKE2b-256 checksum
How to use checksums 		cc1de5b7615cf5c6ca336a26f634e35a239a3d7489246ce121c13ca60eaa4ae6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / kestra_api_client-1.0.0-py3-none-any.whl

Download URL kestra_api_client-1.0.0-py3-none-any.whl
Size 840.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		d5926643031232458c3e3eabfee89ab95d5d4fd95cb08e4899ab6d4103a7cf3f
BLAKE2b-256 checksum
How to use checksums 		f3466e9d5ad7c1cc5fbf9c6ffb787164f714af866192cf2086fce41e2a2e4ad0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Pre-release

1.0.0b5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page