ESC
All(0)
emoticon icon

No results found for the current search

  1. ⚡️ Kestra 0.21 adds no-code flows, custom dashboards & log shippers Learn More

Item 1 of 1
Kestra, Open source declarative data orchestration
  • Product

    • Open Source
      Explore Kestra's Core Capabilities

    • Enterprise Edition
      Security and Governance for Enterprise Needs

    • Cloud EditionPrivate Alpha
      Register for the Cloud Edition

    • Platform Overview
      Powerful capabilities from the UI

    • Start orchestrating your first workflows.

      Quickstart Guide

      • Workflow components
        Get to know the main orchestration components of a Kestra workflow

      • Videos tutorials
        Get started with our video tutorials

  • Solutions

      Features

    • Declarative Orchestration
      Infrastructure as Code for All Your Workflows

    • Automation Platform
      Scheduling and Automation Made Easy

    • Language Agnostic
      Separate your Business Logic from Orchestration Logic

    • Kestra's Terraform Provider
      Deploy and manage all Kestra resources with Terraform

    • API-First
      Learn more about Kestra’s API features

      Use Cases

    • For Data Engineers
      Orchestrate your Data Pipelines, Automate Processes, and Harness the Power of Your Data

    • For Software Engineers
      Boost Productivity, Simplify Processes, and Accelerate Microservice Deployment

    • For Platform Engineers
      Automate, Scale, Provision and Optimize Your Infrastructure

      Industries

    • For Retail
      Empower retail businesses with an event-driven, language-agnostic orchestration platform that scales

    • For Healthcare
      Streamline data processing, accelerate research, and enhance collaboration in healthcare

    • For Automotive
      Ensure seamless operations and optimized performance across all processes.

    • Explore blueprints

      Explore blueprints
      to kick-start
      your next flow.

      Explore
  • Resources

      RESOURCES

    • Blog
      Company news, product updates, and engineering deep dives

    • Video Tutorials
      Get started with our video tutorials

    • FAQ
      FAQ about the product and the company

      DISCOVER

    • Community Overview
      Ask any questions and share your feedback

    • Partners
      Use our partner ecosystem to accelerate your Kestra adoption

    • About Us
      Discover the team and values behind Kestra

    • Platform Overview

      Gorgias, Using Declarative
      Data Engineering
      Orchestration With Kestra

      Explore

      • Customer Stories
        Learn how Enterprises orchestrate their business-critical workflows

  • Docs
  • Plugins
  • Blueprints
  • Pricing
  • Star
    Talk to us Get Started Talk to Us

Product

  • Open Source
    Explore Kestra's Core Capabilities

  • Enterprise Edition
    Security and Governance for Enterprise Needs

  • Cloud EditionPrivate Alpha
    Register for the Cloud Edition

  • Platform Overview
    Powerful capabilities from the UI

Start
orchestrating your
first workflows.

Quickstart Guide

  • Workflow components
    Get to know the main orchestration components of a Kestra workflow

  • Videos tutorials
    Get started with our video tutorials

Features

  • Declarative Orchestration
    Infrastructure as Code for All Your Workflows

  • Automation Platform
    Scheduling and Automation Made Easy

  • Language Agnostic
    Separate your Business Logic from Orchestration Logic

  • Kestra's Terraform Provider
    Deploy and manage all Kestra resources with Terraform

  • API-First
    Learn more about Kestra’s API features

Use Cases

  • For Data Engineers
    Orchestrate your Data Pipelines, Automate Processes, and Harness the Power of Your Data

  • For Software Engineers
    Boost Productivity, Simplify Processes, and Accelerate Microservice Deployment

  • For Platform Engineers
    Automate, Scale, Provision and Optimize Your Infrastructure

Industries

  • For Retail
    Empower retail businesses with an event-driven, language-agnostic orchestration platform that scales

  • For Healthcare
    Streamline data processing, accelerate research, and enhance collaboration in healthcare

  • For Automotive
    Ensure seamless operations and optimized performance across all processes.

Explore blueprints

Explore blueprints to kick-start
your next flow.

Explore

RESOURCES

  • Blog
    Company news, product updates, and engineering deep dives

  • Video Tutorials
    Get started with our video tutorials

  • FAQ
    FAQ about the product and the company

DISCOVER

  • Community Overview
    Ask any questions and share your feedback

  • Partner
    Use our partner ecosystem to accelerate your Kestra adoption

  • About Us
    Discover the team and values behind Kestra

Platform Overview

Gorgias,
Using Declarative Data Engineering Orchestration
With Kestra

20 000+

executions per month

  • Customer Stories
    Learn how Enterprises orchestrate their business-critical workflows

Search

Ctrl + K
  • Get Started with Kestra
  • Getting Started
    • Quickstart
    • Plugins
    • Contributing
    • Community Guidelines
  • Tutorial
    • Fundamentals
    • Inputs
    • Outputs
    • Triggers
    • Flowable Tasks
    • Errors and Retries
    • Docker
  • Architecture
    • Main components
    • Server components
    • Deployment Architecture
    • Executor
    • Worker
    • Scheduler
    • Indexer
    • Webserver
    • Internal Storage
    • Multi-tenancy
  • 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 (Alpha)
  • User Interface
    • Dashboards
    • Flows
    • Executions
    • Logs
    • Namespaces
      • Enterprise Namespace Pages
    • Blueprints
    • Settings
    • Administration
      • Triggers
      • Workers
      • Stats
      • Users
      • Service Accounts
      • Groups
      • Roles
      • Audit Logs
      • Tenants
    • Task Runs
    • Bookmarks
  • Build with Kestra
  • Concepts
    • Namespace Files
    • Revision
    • Secrets
    • Key Value (KV) Store
    • Pebble Templating Engine
    • Blueprints
    • Backfill
    • Replay
    • Data storage and processing
    • Caching
    • Editor
    • System Flows
    • System Labels & Hidden Labels
  • Workflow Components
    • Flow
    • Tasks
      • Flowable Tasks
      • Runnable Tasks
      • Script Tasks (Code in Any Language)
        • Programming Languages
        • Commands and Script tasks
        • Inline Scripts in Docker
        • DOCKER and PROCESS 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
      • 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
  • 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
  • Enterprise Edition
    • Overview
      • Features
      • Enterprise Edition Setup Guide
    • Governance
      • Audit Logs
      • Namespace Management
      • Centralized Task Configuration
      • Custom Blueprints
      • Log Shipper
      • Secrets
      • Secrets Manager
      • Tenants
    • Authentication & Users
      • Authentication
      • Single Sign-On (SSO)
      • 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
    • Scalability & Productivity
      • Apps
      • Task Runners
      • Worker Group
      • Worker Isolation
    • Instance Management
      • Announcements
      • Instance Dashboard
      • Maintenance Mode
    • 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
  • Manage Kestra
  • Administrator Guide
    • Software and Hardware Requirements
    • Alerting & Monitoring
    • Troubleshooting
    • Backup & Restore
    • High Availability
    • OpenTelemetry
    • Purge
    • 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
  • Reference Docs
  • Configuration
  • Expressions
  • API Reference
    • Cloud & Enterprise Edition API
    • Open Source API
  • Terraform Provider
    • Data Sources
      • kestra_binding
      • kestra_flow
      • kestra_group
      • kestra_kv
      • kestra_namespace
      • kestra_namespace_file
      • kestra_role
      • kestra_service_account
      • kestra_template
      • kestra_tenant
      • 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_template
      • kestra_tenant
      • kestra_user
      • kestra_user_api_token
      • kestra_user_password
      • kestra_worker_group
  • Server CLI
  • Kestra EE CLI
docsapi-reference

Cloud & Enterprise Edition API​Cloud & ​Enterprise ​Edition ​A​P​I

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

Available on: Enterprise Edition

API Reference of Kestra Cloud & Enterprise.

Was this page helpful?

DocsAPI Reference
Api ReferenceOpen Source API
Kestra's logo

Open Source Declarative Data Orchestration

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
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

© 2025 Kestra Technologies. Developed with on 🌎.

Privacy Policy / Cookie Policy

Slack