ESC
All(0)
emoticon icon

No results found for the current search

Kestra AIAsk Kestra AI
ESC
Kestra AI

Hi! I'm your Kestra AI assistant.
Ask me anything about workflows.

EXAMPLE QUESTIONS

  1. Live Webinar: Discover Kestra Enterprise 18th December 5pm GMT Register

Item 1 of 1
Kestra, Open source declarative data orchestration
  • Product
    • Core Features
    • Enterprise Edition
    • Cloud EditionRequest Access
  • Solutions

      Capabilities

    • Declarative Orchestration
    • Automation Platform
    • Language Agnostic
    • Kestra's Terraform Provider
    • API-First
    • Platform Overview

      By Roles

    • Data Engineers
    • Software Engineers
    • Platform Engineers

      By Industries

    • Retail & Supply Chain
    • Healthcare & Pharmaceuticals
    • Automotive & Heavy Equipment
    • All use-cases

      Resources

    • About Us
    • Partner
    • FAQ
    • Community Overview
    • Community Contents
    • Customer Stories
    • Changelog
  • Learn
    • Docs
    • Blog
    • Blueprints
    • Video Tutorials
    • How to guides
    • Why kestra
    • Quickstart installation guide.
  • Plugins
  • Pricing
  • Star
    Talk to us Get Started! Talk to Us
  • Core Features

    Explore Kestra's Core Capabilities

  • Enterprise Edition

    Security and Governance for Enterprise Needs

  • Cloud EditionRequest Access

    the Cloud edition managed by Kestra

Capabilities

  • Declarative Orchestration

    Infrastructure as Code of All Your Workflows

  • Automation Platform

    Scheduling and Automation Made Easy

  • Language Agnostic

    Orchestrate business logic in any language

  • Kestra's Terraform Provider

    Deploy & manage all resources with Terraform

  • API-First

    Learn more about Kestra's API features

  • Platform Overview

    Powerful Capabilities from the UI

By Roles

  • Data Engineers
  • Software Engineers
  • Platform Engineers

By Industries

  • Retail & Supply Chain
  • Healthcare & Pharmaceuticals
  • Automotive & Heavy Equipment
  • All use-cases

Resources

  • About Us
  • Partner
  • FAQ
  • Community Overview
  • Community Contents
  • Customer Stories
  • Changelog
  • Docs

    Everything Kestra

  • Blog

    Tutorials, Guides, Market Trends and More

  • Blueprints

    A Library of ready to use Workflows

  • Video Tutorials

    your favourite tutorials in video

  • How to guides

    Learn step by step how to address use-cases

  • Why kestra

    Trust kestra as your unified orchestration tool

  • Quickstart installation guide.

    Trust kestra as your unified orchestration tool

Search

Ctrl + K
  • Get Started with Kestra
  • Getting Started
    • Quickstart
    • Plugins
    • Contribute to Kestra
    • Contribute to Kestra Documentation
    • Community Guidelines
    • Install Only Selected Plugins in Kestra OSS
  • Tutorial
    • Fundamentals
    • Inputs
    • Outputs
    • Triggers
    • Flowable tasks
    • Error Handling
    • Scripts
  • Architecture
    • Main components
    • Server components
    • Deployment architecture
    • Multi-tenancy
    • Data Storage in Kestra
  • Installation Guide
    • Docker
    • Docker Compose
    • Kubernetes
    • Kubernetes on AWS EKS with Amazon RDS and S3
    • Kubernetes on GCP GKE with CloudSQL and Cloud Storage
    • Kubernetes on Azure AKS with Azure Database and Blob Storage
    • AWS EC2 with Amazon RDS and S3
    • GCP VM with Cloud SQL and GCS
    • Azure VM with Azure Database
    • DigitalOcean Droplet with Managed Database
    • Standalone Server
    • Podman Compose
    • Kestra Cloud
  • User Interface
    • Dashboards
    • Flows
    • Executions
    • Logs
    • Namespaces
      • Enterprise Namespace Pages
    • Blueprints
    • Settings
    • Bookmarks
    • Playground
  • Build with Kestra
  • Concepts
    • Namespace Files
    • Revision
    • Secrets
    • Key Value (KV) Store
    • Pebble Templating Engine
    • Blueprints
    • Backfill
    • Replay
    • Data storage and processing
    • Caching
    • Editor
    • File Access in Kestra
    • System Flows
    • System Labels & Hidden Labels
  • Workflow Components
    • Flow
    • Tasks
      • Flowable Tasks
      • Runnable Tasks
      • Task Runs
    • Namespace
    • Execution
    • Variables
    • Inputs
    • Outputs
    • Triggers
      • Schedule Trigger
      • Flow Trigger
      • Webhook Trigger
      • Polling Trigger
      • Realtime Trigger
    • Labels
    • Plugin Defaults
    • Subflows
    • Errors
    • Retries
    • Task timeout
    • Concurrency Limits
    • Descriptions
    • Disabled flag
    • States
    • SLA
    • Finally
    • afterExecution
    • Task Cache
  • Multi-Language Script Tasks
    • Programming Languages
    • Commands and Script Tasks
    • Inline Scripts in Docker
    • Task Runners
    • Building a Custom Docker Image
    • Installing Dependencies at Runtime
    • Outputs and Metrics
    • Input and Output Files
    • Logging
    • Bind Mount
    • Git Clone task
    • Working Directory
  • AI Tools
    • AI Agents
    • AI Copilot
    • RAG Workflows
    • AI Workflows
  • No-Code
    • No-Code Flow Development
    • No-Code Dashboards
  • Version Control & CI/CD
    • Version Control with Git
    • CI/CD Pipeline
      • GitHub Actions
      • GitLab CI
      • Terraform
      • Helpers
      • Azure DevOps
      • Bitbucket Pipes
      • Kubernetes Operator
  • Plugin Developer Guide
    • Setup for Plugin Development
    • Gradle Configuration
    • Develop a Task
    • Develop a Trigger
    • Develop a Condition
    • Add Unit Tests
    • Document Your Plugin
    • Build and Publish a Plugin
  • How-to Guides
  • Scale with Kestra
  • Cloud & Enterprise Edition
    • Overview
      • Features
      • Enterprise Edition Setup Guide
      • Standalone Server Installation Guide (Enterprise Edition)
    • Governance
      • Audit Logs
      • Namespace Management
      • Allowed & Restricted Plugins
      • Custom Blueprints
      • Log Shipper
      • Read-only Secret Manager
      • Secrets
      • Secrets Manager
      • Tenants
      • Unit Tests
      • Worker Isolation
    • Authentication & Users
      • Authentication
      • Kestra EE API
      • API Tokens
      • Invitations
      • Role-Based Access Control (RBAC)
      • SCIM Directory Sync
        • authentik SCIM Provisioning
        • Keycloak SCIM Provisioning
        • Microsoft Entra ID SCIM Provisioning
        • Okta SCIM Provisioning
      • Service Accounts
      • Single Sign-On (SSO)
        • Configure authentik SSO
        • Google as an OIDC SSO Provider
        • Configure Keycloak SSO
        • LDAP
        • Microsoft as an OIDC SSO Provider
        • Okta as an OIDC SSO Provider
    • Scalability & Productivity
      • Apps
      • Task Runners
      • Worker Group
    • Instance Management
      • Announcements
      • Instance Dashboard
      • Maintenance Mode
      • Versioned Plugins
    • Cloud & Enterprise Edition FAQ
  • Task Runners
    • Task Runner Overview
    • Task Runner Benefits
    • Task Runner vs. Worker Group
    • Task Runner Types
      • Process Task Runner
      • Docker Task Runner
      • Kubernetes Task Runner
      • AWS Batch Task Runner
      • Azure Batch Task Runner
      • Google Batch Task Runner
      • Google Cloud Run Task Runner
  • Best Practices
    • Flow Best Practices
    • Moving from Development to Production
    • Naming Conventions
    • Manage Environments
    • Managing pip Package Dependencies
    • Expressions with Namespace Files
    • Version Control with Git
    • Managing and Purging Flow Outputs
    • Business Units Separation
    • Best Practices for Secrets in Kestra
  • Manage Kestra
  • Administrator Guide
    • Software and Hardware Requirements
    • Alerting & Monitoring
    • Troubleshooting
    • Backup & Restore
    • Troubleshooting Basic Authentication
    • MITM Proxy for DinD
    • High Availability
    • MITM Proxy for Kestra
    • OpenTelemetry
    • Prometheus Metrics
    • Purge
    • Security Hardening
    • Server Components Liveness
    • Configure SSL for Kestra
    • Managing Upgrades
    • Usage
    • Webserver URL
  • Migration Guide
    • 0.11.0
      • Script tasks moved to dedicated plugins
      • Deprecation of Templates
    • 0.12.0
      • Deprecation of Listeners
    • 0.13.0
      • Sync Users Access to a Default Tenant
    • 0.14.0
      • Change in managing Groups via the API
      • Recursive rendering of Pebble expressions
    • 0.15.0
      • Inputs Name
      • Migration to Micronaut 4.3
      • Schedule Conditions
      • Subflow outputs behavior
    • 0.17.0
      • JSON Object Serialization
      • Deprecation of LocalFiles and outputDir
      • Plugin Discovery Mechanism
      • Renamed Plugins
      • Volume Mount
    • 0.18.0
      • Deprecation of runner property in favor of taskRunner
      • Deprecation of Terraform task_defaults in favor of plugin_defaults
    • 0.19.0
      • Deprecation of State Store in favor of KV Store
    • 0.20.0
      • Different permissions for accessing Cluster Monitoring
      • Conditions renamed
      • Custom plugins
      • Elasticsearch indexer
      • Retrieving KV pairs from other namespaces
      • Restore Kafka queue
      • Server configuration
      • Usernames replaced by email addresses
      • Fallback on unhealthy workers
    • 0.21.0
      • Default Git Branch
      • Restarting parent flow
      • Retrieving non-existing secrets
      • Log level for stderr output
      • ME and APITOKEN user permissions
    • 0.22.0
      • Azure Log Exporter
      • Default Tenant & Multi-Tenancy
      • Enterprise Edition API changes
      • Failed Attempts Lockout
      • Helm Chart Health Check Paths
      • KV function errors on missing key
      • Version property renamed
    • 0.23.0
      • The BOOLEAN-type input is deprecated in favor of BOOL
      • Default environment variable prefix changed from KESTRA_ to ENV_ for security
      • The default pullPolicy for Docker-based tasks changed
      • Flow trigger now also reacts to PAUSED state by default
      • Internal Storage Migration Guide for S3 and GCS Users
      • The autocommit property removed from JDBC Query and Queries tasks
      • LoopUntil task changed default values for checkFrequency
      • Python script tasks now use official python:3-13-slim image
      • No more WARNING state on script tasks when ERROR logs are present
      • SQL Server backend is no longer supported
      • Manual user refresh to migrate Superadmin property
      • Enterprise Migration Guide from defaultTenant to Multitenancy
      • Open-Source Migration Guide to introduce defaultTenant
      • Removal of tenant from Superadmin API routes
    • 0.24.0
      • Required Basic Authentication
      • Capture filename on input type FILE
      • IAM and API Endpoint Changes
      • Migrate from LangChain4j Plugin to Plugin AI
      • maxAttempt renamed maxAttempts
    • 1.0.0
      • Internal Package Structure Changes (Custom Plugins Only)
      • Helm Chart Updates
      • Input defaults are now dynamic
      • Audit Log's permissions are renamed to resources
      • Reserved keywords cannot be used as Flow IDs
      • Singer Tap Plugin Removal
    • 1.1.0
      • ForEachItem now starts iteration at 0 instead of 1
      • Key-value Store and Secrets Metadata Migration
      • New prefill Property for Inputs
      • The Query Task Now Supports Only One SQL Statement
      • Task Runs UI Page Removed
      • Webhook Execution API Return Type Changed
  • Performance
    • Benchmarks
    • Performance Tuning
    • Sizing and Scaling Infrastructure
  • Reference Docs
  • Configuration
  • Releases & LTS Policy
  • Expressions
  • API Reference
    • Cloud & Enterprise Edition API
    • Open Source API
    • Kestra SDK
      • Kestra Java SDK
      • Kestra Python SDK
  • Terraform Provider
    • Data Sources
      • kestra_binding
      • kestra_flow
      • kestra_group
      • kestra_kv
      • kestra_namespace
      • kestra_namespace_file
      • kestra_role
      • kestra_service_account
      • kestra_service_account_api_tokens
      • kestra_template
      • kestra_tenant
      • kestra_test
      • kestra_user
      • kestra_user_api_tokens
      • kestra_worker_group
    • Guides
      • Provider configurations
      • Working with Yaml
    • Resources
      • kestra_app
      • kestra_binding
      • kestra_dashboard
      • kestra_flow
      • kestra_group
      • kestra_kv
      • kestra_namespace
      • kestra_namespace_file
      • kestra_namespace_secret
      • kestra_role
      • kestra_security_integration
      • kestra_service_account
      • kestra_service_account_api_token
      • kestra_template
      • kestra_tenant
      • kestra_test
      • kestra_user
      • kestra_user_api_token
      • kestra_user_password
      • kestra_worker_group
  • Kestra CLI
  1. Docs
  2. API Reference
  3. Open Source API

Open Source API​Open ​Source ​A​P​I

Contribute
  • Edit this page
  • Join us on Slack
  • YouTube
  • GitHub
  • Twitter
  • BlueSky
  • LinkedIn

API Reference of the Open-Source edition of Kestra.

Was this page helpful?

Send Feedback

😔

Api ReferenceCloud & Enterprise Edition API
Api ReferenceKestra SDK
Kestra's logo

Open Source Declarative Orchestration

Get Kestra updates

Stay up to date with the latest features and changes to Kestra

Product
  • Platform Overview
  • Open Source
  • Enterprise Edition
  • Kestra Cloud
  • Pricing
Solutions
  • Use Cases
  • Declarative Orchestration
  • Automation Platform
  • API First
  • Code in Any Language
  • Terraform Provider
  • Airflow vs Kestra
  • Prefect vs Kestra
  • Dagster vs Kestra
  • AWS Step Functions vs Kestra
Community
  • Community Overview
  • Blog
  • Write for Us
  • Slack
  • GitHub
Docs
  • Documentation
  • Plugins
  • Blueprints
  • Getting Started
  • Administrator Guide
  • FAQ
Company
  • About Us
  • Careers Hiring!
  • Contact Us
  • Customer Stories
  • Partners Ecosystem
SOC 2GDPR

© 2025 Kestra Technologies. Developed with on 🌎.

Privacy Policy / Cookie Policy

Slack