Kestra Plugin ExportById

Kestra Plugin ExportById

Certified

Export flows by id

Exports specific flows identified by namespace and id into a ZIP stored in internal storage; returns the stored URI.

yaml
type: io.kestra.plugin.kestra.flows.ExportById

Export a single flow

yaml
id: export_single_flow
namespace: company.team

tasks:
  - id: export_flow_by_id
    type: io.kestra.plugin.kestra.flows.ExportById
    kestraUrl: http://localhost:8080
    auth:
      username: admin@kestra.io # pass your Kestra username as secret or KV pair
      password: "{{ secret('KESTRA_PASSWORD') }}" # pass your Kestra password as secret or KV pair
    flows:
      - id: my_flow_id
        namespace: my.flow.namespace

Export multiple flows from different namespaces

yaml
id: export_multiple_flows
namespace: company.team

tasks:
  - id: export_flows
    type: io.kestra.plugin.kestra.flows.ExportById
    kestraUrl: https://my-ee-instance.io
    auth:
      username: admin@kestra.io # pass your Kestra username as secret or KV pair
      password: "{{ secret('KESTRA_PASSWORD') }}" # pass your Kestra password as secret or KV pair
    tenantId: main
    flows:
      - id: flow_one
        namespace: prod.data
      - id: flow_two
        namespace: dev.analytics
      - id: flow_three
        namespace: common.utils
Properties

Select API authentication

Use either an API token or HTTP Basic (username/password); do not provide both.

Definitions
apiTokenstring

API token for bearer auth

autobooleanstring
Defaulttrue

Automatically retrieve credentials from Kestra's configuration if available

The default configuration can be configured globally inside the Kestra configuration file:

  • Set kestra.tasks.sdk.authentication.api-token to use an API token
  • Set kestra.tasks.sdk.authentication.username and kestra.tasks.sdk.authentication.password for HTTP basic authentication
  • Set kestra.tasks.sdk.authentication.url to also default the Kestra API endpoint (see kestraUrl above) The Enterprise edition also provides setting a default configuration at the Namespace or Tenant level by an administrator. Set to false to also opt out of the default URL.
passwordstring

Password for HTTP Basic auth

usernamestring

Username for HTTP Basic auth

Flows to export

List of id/namespace pairs.

Definitions
idstring
namespacestring

Override Kestra API endpoint

URL used for calls to the Kestra API. When null, falls back to the url configured alongside the default SDK authentication (Namespace or Tenant level, Enterprise edition), then renders {{ kestra.url }} from configuration; if still empty, defaults to http://localhost: 8080. Trailing slashes are stripped before use.

Reference (ref) of the pluginDefaults to apply to this task.

Override target tenant

Tenant identifier applied to API calls; defaults to the current execution tenant.

Formaturi

URI of the exported flows ZIP file

More Plugins in this Category

Core Plugins and tasks
Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

Core

122 tasks

580 blueprints

Ruby
Ruby

Tasks that run Ruby scripts.

Core

4 tasks