Pre-release

This release is a pre-release and may not be stable for production use.

@kestra-io/kestrapy

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

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0-SNAPSHOT
  • Package version: 2.0.0-rc2
  • Generator version: 7.25.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

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 kestrapy

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 kestrapy

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import kestrapy
from kestrapy.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 = kestrapy.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = kestrapy.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (Bearer): bearerAuth
configuration = kestrapy.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with kestrapy.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kestrapy.ExecutionsApi(api_client)
    namespace = 'namespace_example' # str | The flow namespace
    id = 'id_example' # str | The flow id
    tenant = 'tenant_example' # str | 
    labels = ['labels_example'] # List[str] | The labels as a list of 'key:value' (optional)
    wait = False # bool | If the server will wait the end of the execution (optional) (default to False)
    revision = 56 # int | The flow revision or latest if null (optional)
    schedule_date = '2013-10-20T19:20:30+01:00' # datetime | Schedule the flow on a specific date (optional)
    breakpoints = 'breakpoints_example' # str | Set a list of breakpoints at specific tasks 'id.value', separated by a coma. (optional)
    kind = kestrapy.ExecutionKind() # ExecutionKind | Specific execution kind (optional)

    try:
        # Create a new execution for a flow
        api_response = api_instance.create_execution(namespace, id, tenant, labels=labels, wait=wait, revision=revision, schedule_date=schedule_date, breakpoints=breakpoints, kind=kind)
        print("The response of ExecutionsApi->create_execution:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExecutionsApi->create_execution: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
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_expression POST /api/v1/{tenant}/executions/{executionId}/actions/eval Evaluate a variable expression for this execution
ExecutionsApi eval_task_run_expression POST /api/v1/{tenant}/executions/{executionId}/actions/eval/{taskRunId} Evaluate a variable expression for this taskrun
ExecutionsApi execution GET /api/v1/{tenant}/executions/{executionId} Get an execution
ExecutionsApi execution_average_duration GET /api/v1/{tenant}/executions/namespaces/{namespace}/flows/{flowId}/average-duration Get the average duration of the recent executions of a flow, used to estimate the progress of a running execution.
ExecutionsApi execution_flow_graph GET /api/v1/{tenant}/executions/{executionId}/graph Generate a graph for an execution
ExecutionsApi export_executions GET /api/v1/{tenant}/executions/export/by-query/csv Export all executions as a streamed CSV file
ExecutionsApi file_metadatas_from_execution GET /api/v1/{tenant}/executions/{executionId}/file/metas Get file meta information for an execution
ExecutionsApi find_distinct_field_values GET /api/v1/{tenant}/executions/distinct-field-values List distinct values for one of the executions filter fields, optionally narrowed by additional query filters
ExecutionsApi flow_from_execution GET /api/v1/{tenant}/executions/flows/{namespace}/{flowId} Get flow information's for an execution
ExecutionsApi flow_from_execution_by_id GET /api/v1/{tenant}/executions/{executionId}/flow Get flow information's for an execution
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 asynchronously
ExecutionsApi force_run_execution POST /api/v1/{tenant}/executions/{executionId}/actions/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 asynchronously
ExecutionsApi kill_execution DELETE /api/v1/{tenant}/executions/{executionId}/actions/kill Kill an execution
ExecutionsApi kill_executions_by_ids DELETE /api/v1/{tenant}/executions/kill/by-ids Kill a list of executions asynchronously
ExecutionsApi kill_executions_by_query DELETE /api/v1/{tenant}/executions/kill/by-query Kill executions filter by query parameters
ExecutionsApi latest_executions POST /api/v1/{tenant}/executions/latest Get the latest execution for given flows
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}/actions/pause Pause a running execution.
ExecutionsApi pause_executions_by_ids POST /api/v1/{tenant}/executions/pause/by-ids Pause a list of running executions asynchronously
ExecutionsApi pause_executions_by_query POST /api/v1/{tenant}/executions/pause/by-query Pause executions filter by query parameters asynchronously
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}/actions/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}/actions/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 asynchronously. 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 asynchronously. Keep the flow revision
ExecutionsApi restart_execution POST /api/v1/{tenant}/executions/{executionId}/actions/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 asynchronously
ExecutionsApi restart_executions_by_query POST /api/v1/{tenant}/executions/restart/by-query Restart executions filter by query parameters asynchronously
ExecutionsApi resume_execution POST /api/v1/{tenant}/executions/{executionId}/actions/resume Resume a paused execution.
ExecutionsApi resume_execution_from_breakpoint POST /api/v1/{tenant}/executions/{executionId}/actions/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 asynchronously
ExecutionsApi resume_executions_by_query POST /api/v1/{tenant}/executions/resume/by-query Resume executions filter by query parameters asynchronously
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 set_labels_on_terminated_execution POST /api/v1/{tenant}/executions/{executionId}/actions/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 asynchronously
ExecutionsApi set_labels_on_terminated_executions_by_query POST /api/v1/{tenant}/executions/labels/by-query Set label on executions filter by query parameters asynchronously
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_get_webhook_with_path GET /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}/{path} 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_post_webhook_with_path POST /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}/{path} 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 trigger_execution_by_put_webhook_with_path PUT /api/v1/{tenant}/executions/webhook/{namespace}/{id}/{key}/{path} Trigger a new execution by PUT webhook trigger
ExecutionsApi unqueue_execution POST /api/v1/{tenant}/executions/{executionId}/actions/unqueue Unqueue an execution
ExecutionsApi unqueue_executions_by_ids POST /api/v1/{tenant}/executions/unqueue/by-ids Unqueue a list of executions asynchronously
ExecutionsApi unqueue_executions_by_query POST /api/v1/{tenant}/executions/unqueue/by-query Unqueue executions filter by query parameters asynchronously
ExecutionsApi update_execution_status POST /api/v1/{tenant}/executions/{executionId}/actions/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 asynchronously
ExecutionsApi update_executions_status_by_query POST /api/v1/{tenant}/executions/change-status/by-query Change executions state by query parameters asynchronously
ExecutionsApi update_task_run_state POST /api/v1/{tenant}/executions/{executionId}/actions/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}/actions/resume/validate Validate inputs to resume a paused execution.
FlowsApi apply_replace_by_source_code POST /api/v1/{tenant}/flows/source/replace/apply Apply a Source Search replace-all operation
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 delete_revisions DELETE /api/v1/{tenant}/flows/{namespace}/{id}/revisions Delete revisions for a flow
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 GET /api/v1/{tenant}/flows/export/by-query/csv Export all flows as a streamed CSV file
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 expressions POST /api/v1/{tenant}/flows/expressions Get available Pebble expressions for a flow
FlowsApi flow GET /api/v1/{tenant}/flows/{namespace}/{id} Get a flow
FlowsApi flow_dependencies GET /api/v1/{tenant}/flows/{namespace}/{id}/dependencies Get flow dependencies
FlowsApi flow_dependencies_from_namespace GET /api/v1/{tenant}/namespaces/{namespace}/dependencies Retrieve flow dependencies
FlowsApi flow_hashes_by_ids POST /api/v1/{tenant}/flows/hashes/by-ids Batch-compute source hashes for flows by id (drift detection)
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 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_deprecated GET /api/v1/{tenant}/flows/deprecated List flows containing deprecated tasks
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 preview_policies POST /api/v1/{tenant}/flows/policies/preview Preview the governance policy effects (mutations + violations) on a flow source
FlowsApi preview_replace_by_source_code POST /api/v1/{tenant}/flows/source/replace/preview Preview a Source Search replace-all operation
FlowsApi replace_line_by_source_code POST /api/v1/{tenant}/flows/source/replace/line Apply a Source Search replace on a single match line
FlowsApi search_concurrency_limits GET /api/v1/{tenant}/concurrency-limit/search Search for flow concurrency limits
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 task_from_flow GET /api/v1/{tenant}/flows/{namespace}/{id}/tasks/{taskId} Get a flow task
FlowsApi update_concurrency_limit PUT /api/v1/{tenant}/concurrency-limit/{namespace}/{flowId} Update a flow concurrency limit
FlowsApi update_flow PUT /api/v1/{tenant}/flows/{namespace}/{id} Update a flow
FlowsApi update_flows_in_namespace POST /api/v1/{tenant}/flows/{namespace} Update a complete namespace from yaml source
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 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
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 key_value GET /api/v1/{tenant}/namespaces/{namespace}/kv/{key} Get value for a key
KVApi list_all_keys GET /api/v1/{tenant}/kv List all keys
KVApi list_keys_with_inheritence GET /api/v1/{tenant}/namespaces/{namespace}/kv/inheritance List all keys for inherited namespaces
KVApi set_key_value PUT /api/v1/{tenant}/namespaces/{namespace}/kv/{key} Puts a key-value pair in store
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 inherited_secrets GET /api/v1/{tenant}/namespaces/{namespace}/inherited-secrets List inherited secrets
NamespacesApi inherited_variables GET /api/v1/{tenant}/namespaces/{id}/inherited-variables List inherited variables
NamespacesApi namespace GET /api/v1/{tenant}/namespaces/{id} Get 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
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 list_roles_from_given_ids POST /api/v1/{tenant}/roles/ids List roles by ids
RolesApi role GET /api/v1/{tenant}/roles/{id} Retrieve a role
RolesApi search_roles GET /api/v1/{tenant}/roles/search Search for roles
RolesApi update_role PUT /api/v1/{tenant}/roles/{id} Update a role
ServiceAccountApi create_api_tokens_for_service_account POST /api/v1/service-accounts/{id}/api-tokens Create new API Token for a specific service account
ServiceAccountApi create_api_tokens_for_service_account_with_tenant POST /api/v1/{tenant}/service-accounts/{id}/api-tokens Create new API Token for a specific service account
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_api_token_for_service_account DELETE /api/v1/service-accounts/{id}/api-tokens/{tokenId} Delete an API Token for specific service account and token id
ServiceAccountApi delete_api_token_for_service_account_with_tenant DELETE /api/v1/{tenant}/service-accounts/{id}/api-tokens/{tokenId} Delete an API Token for specific service account and token id
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 list_api_tokens_for_service_account GET /api/v1/service-accounts/{id}/api-tokens List API tokens for a specific service account
ServiceAccountApi list_api_tokens_for_service_account_with_tenant GET /api/v1/{tenant}/service-accounts/{id}/api-tokens List API tokens for a specific service account
ServiceAccountApi list_service_accounts GET /api/v1/service-accounts List service accounts. Instance-owner-only.
ServiceAccountApi list_service_accounts_for_tenant GET /api/v1/{tenant}/service-accounts List service accounts for the given tenant
ServiceAccountApi patch_service_account_details PATCH /api/v1/service-accounts/{id} Update service account details
ServiceAccountApi patch_service_account_instance_owner PATCH /api/v1/service-accounts/{id}/instanceowner Update service account instance-owner privileges
ServiceAccountApi patch_service_account_instance_owner_legacy PATCH /api/v1/service-accounts/{id}/superadmin Update service account instance-owner privileges (deprecated)
ServiceAccountApi service_account GET /api/v1/service-accounts/{id} Get a service account
ServiceAccountApi service_account_for_tenant GET /api/v1/{tenant}/service-accounts/{id} Retrieve a service account
ServiceAccountApi update_service_account PUT /api/v1/{tenant}/service-accounts/{id} Update a user service account
TriggersApi create_backfill PUT /api/v1/{tenant}/triggers/backfill/create Create a backfill
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 asynchronously
TriggersApi delete_backfill_by_query POST /api/v1/{tenant}/triggers/backfill/delete/by-query Delete backfill for triggers matching query asynchronously
TriggersApi delete_trigger DELETE /api/v1/{tenant}/triggers/{namespace}/{flowId}/{triggerId} Delete a trigger
TriggersApi delete_triggers_by_ids DELETE /api/v1/{tenant}/triggers/delete/by-triggers Delete given triggers asynchronously
TriggersApi delete_triggers_by_query DELETE /api/v1/{tenant}/triggers/delete/by-query Delete triggers by query parameters asynchronously
TriggersApi disable_trigger_by_id PUT /api/v1/{tenant}/triggers/set-disabled Disable/enable a trigger
TriggersApi disabled_triggers_by_ids POST /api/v1/{tenant}/triggers/set-disabled/by-triggers Disable/enable given triggers asynchronously
TriggersApi disabled_triggers_by_query POST /api/v1/{tenant}/triggers/set-disabled/by-query Disable/enable triggers by query parameters asynchronously
TriggersApi export_triggers GET /api/v1/{tenant}/triggers/export/by-query/csv Export all triggers as a streamed CSV file
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 asynchronously
TriggersApi pause_backfill_by_query POST /api/v1/{tenant}/triggers/backfill/pause/by-query Pause backfill for triggers matching query asynchronously
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 asynchronously
TriggersApi unlock_triggers_by_query POST /api/v1/{tenant}/triggers/unlock/by-query Unlock triggers by query parameters asynchronously
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 asynchronously
TriggersApi unpause_backfill_by_query POST /api/v1/{tenant}/triggers/backfill/unpause/by-query Unpause backfill for triggers matching query asynchronously
UsersApi autocomplete_users POST /api/v1/{tenant}/tenant-access/autocomplete List users for autocomplete
UsersApi create_api_tokens_for_user POST /api/v1/users/{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_for_user DELETE /api/v1/users/{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} Delete user auth method
UsersApi list_api_tokens_for_user GET /api/v1/users/{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_instance_owner PATCH /api/v1/users/{id}/instanceowner Update user instance-owner privileges
UsersApi patch_user_instance_owner_legacy PATCH /api/v1/users/{id}/superadmin Update user instance-owner privileges (deprecated)
UsersApi patch_user_password PATCH /api/v1/users/{id}/password Update user password
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
UsersApi user GET /api/v1/users/{id} Get a user

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:
Newer release available (2.0.1)

1 maintainer

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

Credits

Author: OpenAPI Generator community

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Kestra EE

Report project as malware

Release files for kestrapy 2.0.0rc2

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

Source distribution (sdist)

Source distribution for kestrapy 2.0.0rc2
File Size Uploaded
kestrapy-2.0.0rc2.tar.gz 305.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kestrapy 2.0.0rc2
File Interpreter ABI Platform
kestrapy-2.0.0rc2-py3-none-any.whl 1.1 MB Python 3 none any Details

Total release size: 1.4 MB

Release files / kestrapy-2.0.0rc2.tar.gz

Download URL kestrapy-2.0.0rc2.tar.gz
Size 305.2 kB
Tags Source
SHA-256 checksum
How to use checksums 		1e9b04b4afad2f8ccaefa82252dc304250f563e00ea7b3e5583e45f1cfb8c5e6
BLAKE2b-256 checksum
How to use checksums 		933649b68921cbde7d971e26a77195b767e4ba35ff691273bc28e0a39b956b0e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / kestrapy-2.0.0rc2-py3-none-any.whl

Download URL kestrapy-2.0.0rc2-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums 		656bc9c04b151365960337daef3d7def68499471702f8031bda6b15302b30491
BLAKE2b-256 checksum
How to use checksums 		aa837bfdedaf5b006139039e691a95106af9e560dd3fa9b58ee21af8d879fe30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/7.0.0 CPython/3.13.14
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