ESC
All(0)
Kestra, Open source declarative data orchestrationKestra, Open source declarative data orchestration
  • Product

    • Platform Overview
      Powerful capabilities from the UI

    • 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

      Platform overview

  • Solutions

      Features

    • Declarative Orchestration
      Infrastructure as Code for All Your Workflows

    • Automation Platform
      Scheduling and Automation Made Easy

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

    • Language Agnostic
      Separate your Business Logic from Orchestration Logic

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

      • 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
      Empowers 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.

  • Docs
  • Plugins
  • Resources

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

    • Video Tutorials
      Get started with our video tutorials

    • Community Overview
      Ask any questions and share your feedback

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

    • Partners
      Use our partner ecosystem to accelerate your Kestra adoption

    • FAQ
      FAQ about the product and the company

    • Platform blueprints

      Explore blueprints

    • About Us
      Read about our story and meet our team

    • Careers
      Join a remote-first company

    • Contact us
      Get in touch with us

  • Pricing
  • Star
    Talk to Us Get Started Talk to Us

Search

Ctrl + K
  • Welcome to Kestra
    • Quickstart
    • Installation Guide
    • Tutorial
    • Workflow Components
    • Concepts
    • Enterprise Edition
    • Architecture
    • Developer Guide
    • Plugins
    • Administrator Guide
    • Configuration Guide
    • API Reference
    • Migration Guide
    • Terraform Provider
    • User Interface
    • Contributing
    • How-to Guides
    • Community Guidelines
  • 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
    • Restack
    • 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)
  • Tutorial
    • Fundamentals
    • Inputs
    • Outputs
    • Triggers
    • Flowable Tasks
    • Errors and Retries
    • Docker
  • Workflow Components
    • Flow
    • Tasks
    • Namespace
    • Execution
    • Variables
    • Inputs
    • Outputs
    • Triggers
      • Schedule Trigger
      • Flow Trigger
      • Webhook Trigger
      • Polling Trigger
      • Realtime Trigger
    • Labels
    • Plugin Defaults
    • Subflows
    • Errors
    • Retries
    • Timeout
    • Concurrency limits
    • Descriptions
    • Disabled flag
    • States
  • Concepts and Expressions
    • Flowable Tasks
    • Runnable Tasks
    • Revision
    • Secret
    • Key Value (KV) Store
    • Pebble Templating Engine
    • Blueprints
    • Backfill
    • 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
    • Replay
    • Expression
      • Expression Types
      • Expression Usage
      • Filter
        • JSON Filters
        • Numeric Filters
        • Object Filters (Maps, Arrays and More)
        • String Filters
        • Temporal Filters
        • YAML Filters
      • Function
      • Operator
      • Tag
      • Test
      • Deprecated handlebars
  • Kestra Enterprise
    • Enterprise Edition (EE)
    • Setup
    • Tenants
    • Authentication
    • Single Sign-On (SSO)
    • Audit Logs
    • Namespace Management
    • Centralized Task Configuration
    • Allowed namespaces
    • Kestra EE API
    • API Tokens
    • Kestra EE CLI
    • Custom Blueprints
    • Enterprise Edition FAQ
    • Kestra Identity
    • Role-Based Access Control (RBAC)
    • SCIM Directory Sync
      • authentik SCIM Provisioning
      • Keycloak SCIM Provisioning
      • Microsoft Entra ID SCIM Provisioning
      • Okta SCIM Provisioning
    • Secrets
    • Secrets Manager
    • Service Accounts
    • Task Runners
    • Worker Group
    • Worker Isolation
  • Architecture
    • Main components
    • Server components
    • Deployment Architecture
    • Executor
    • Worker
    • Scheduler
    • Indexer
    • Webserver
    • Internal Storage
    • Multi-tenancy
  • Developer Guide
    • Data storage and processing
    • Errors and retries
    • Namespace Files
    • Version Control with Git
    • Caching
    • Build a Custom Plugin
    • Python, R, Node.js and Shell Scripts
      • Programming Languages
      • Commands and Script tasks
      • Inline Scripts in Docker
      • DOCKER and PROCESS runners
      • Building a custom Docker image
      • Installing dependencies at runtime
      • Additional languages (Rust)
      • Bind mount
      • The Git Clone task
      • Input and Output Files
      • Outputs and metrics
      • Working Directory
    • Create a CI/CD pipeline
      • GitHub Actions
      • GitLab CI
      • Terraform
      • Helpers
      • Azure DevOps
      • BitBucket Pipes
  • Administrator Guide
    • Software and Hardware Requirements
    • Alerting & Monitoring
    • Kestra Server CLI
    • Troubleshooting
    • High Availability
    • Purge
    • Managing Upgrades
  • Configuration Guide
    • Configuration Setup
    • Database
    • Storage
    • Enterprise Edition
    • API Retries
    • Elasticsearch
    • Enabled
    • Encryption
    • Endpoints
    • Environment
    • JVM
    • Kafka
    • Logging
    • Metrics
    • Micronaut
    • Plugins
    • Server
    • System Flows
    • Tasks
    • Tutorial Flows
    • URL
    • Usage
    • Variables
    • Webserver
  • Migration Guide
    • 0.11.0
      • Script tasks moved to dedicated plugins
      • Deprecation of Templates
    • 0.12.0
      • Deprecation of Listeners
    • 0.14.0
      • Recursive rendering of Pebble expressions
    • 0.15.0
      • Inputs Name
      • Migration to Micronaut 4.3
      • Schedule Conditions
      • Subflow outputs behavior
    • 0.17.0
      • 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
  • API Reference
    • Enterprise Edition API Reference
    • Open Source API Reference
  • Terraform Provider
    • Data Sources
      • kestra_binding
      • kestra_flow
      • kestra_group
      • kestra_kv
      • kestra_namespace
      • kestra_namespace_file
      • kestra_role
      • kestra_template
      • kestra_tenant
      • kestra_user
    • Guides
      • Provider configurations
      • Working with Yaml
    • Resources
      • kestra_binding
      • kestra_flow
      • kestra_group
      • kestra_kv
      • kestra_namespace
      • kestra_namespace_file
      • kestra_namespace_secret
      • kestra_role
      • kestra_template
      • kestra_tenant
      • kestra_user
      • kestra_user_password
  • Videos Tutorials
  • Best Practices
    • Flow best practices
    • Moving from Development to Production
    • Version Control with Git
    • Manage Environments
    • Managing pip package dependencies
    • Naming conventions
    • Pebble Templating with Namespace Files
  • How-to Guides
    • Conditional Branching
    • Custom Plugin
    • Google Service Accounts
    • Google Sheets
    • HTTP Requests
    • Pass Inputs via an API call
    • Validate Inputs with Enum Data Type
    • JavaScript
    • KeyCloak SSO
    • Kestra Secrets from a Helm Chart
    • Loop Over a List of Values
    • Monitoring with Grafana & Prometheus
    • Multiple Condition Listener
    • Handling null and undefined values
    • Parallel vs. Sequential Tasks
    • Pause and Resume
    • PushFlows Task
    • PushNamespaceFiles Task
    • Python
    • Realtime Triggers
    • Revision History & Rollback
    • Secrets
    • Shell Script
    • Migrate from Shipyard
    • Slack Events API
    • SSL Configuration
    • SyncFlows Task
    • Synchronous Executions API
    • SyncNamespaceFiles Task
    • Modularize your triggers and schedules with Terraform
    • Leverage Terraform for flow modularity
    • Webhooks
DocsAPI ReferenceEnterprise Edition API Reference

Enterprise Edition API Reference​Enterprise ​Edition ​A​P​I ​Reference

Contribute
  • Join us on Slack
  • YouTube
  • GitHub
  • Twitter
  • LinkedIn

Available on: Enterprise Edition

The API reference of Kestra Enterprise.

Was this page helpful?

DocsAPI Reference
Api ReferenceOpen Source API Reference
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

© 2024 Kestra Technologies. Developed with on 🌎.

Privacy Policy / Cookie Policy

Slack