Kestra Plugin Export

Kestra Plugin Export

Certified

Export flows by namespace/labels

Exports flows matching namespace prefix and optional labels into a ZIP written to internal storage. Returns the stored URI.

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

Export a single flow

yaml
id: export_single_flow
namespace: company.team

tasks:
  - id: export_flow
    type: io.kestra.plugin.kestra.flows.Export
    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
    namespace: company.team
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

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.

SubTypestring

Label filters

List of key: value labels all flows must contain.

Namespace prefix

Limit export to flows whose namespace matches this prefix.

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