Kestra Plugin List

Kestra Plugin List

Certified

List flows in a namespace

Retrieves flows for the given namespace; defaults to the current flow namespace when unset.

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

List flows in the current namespace

yaml
id: list_current_namespace_flows
namespace: company.team.myflow

tasks:
  - id: list_flows
    type: io.kestra.plugin.kestra.flows.List
    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

List flows in a specific namespace

yaml
id: list_specific_namespace_flows
namespace: company.team.admin

tasks:
  - id: list_dev_flows
    type: io.kestra.plugin.kestra.flows.List
    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
    namespace: dev.flows
    tenantId: myorganization
Properties

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

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, and to call a Kestra API that requires no authentication when no credentials are set either.
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.

Namespace to list

Defaults to the current flow namespace when null.

Override target tenant

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

A list of Kestra flows found

Definitions
afterExecutionarray
additionalPropertiesobject
allowFailureboolean
allowWarningboolean
descriptionstring
disabledboolean
idstring
logLevelstring
Possible Values
ERRORWARNINFODEBUGTRACEUNKNOWN_DEFAULT_OPEN_API
logToFileboolean
retryobject
taskCache
enabledboolean
ttlstring
timeoutstring
typestring
versionstring
whenstring
workerSelector
fallbackstring
Possible Values
FAILWAITCANCELIGNORE
matchstring
Possible Values
ALLANY
tagsarray
SubTypestring
checksarray
behaviorstring
Possible Values
BLOCK_EXECUTIONFAIL_EXECUTIONCREATE_EXECUTIONUNKNOWN_DEFAULT_OPEN_API
messagestring
stylestring
Possible Values
ERRORSUCCESSWARNINGINFOUNKNOWN_DEFAULT_OPEN_API
whenstring
concurrency
behaviorstring
Possible Values
QUEUECANCELFAILUNKNOWN_DEFAULT_OPEN_API
limitinteger
deletedboolean
descriptionstring
disabledboolean
draftboolean
errorsarray
additionalPropertiesobject
allowFailureboolean
allowWarningboolean
descriptionstring
disabledboolean
idstring
logLevelstring
Possible Values
ERRORWARNINFODEBUGTRACEUNKNOWN_DEFAULT_OPEN_API
logToFileboolean
retryobject
taskCache
enabledboolean
ttlstring
timeoutstring
typestring
versionstring
whenstring
workerSelector
fallbackstring
Possible Values
FAILWAITCANCELIGNORE
matchstring
Possible Values
ALLANY
tagsarray
SubTypestring
idstring
inputsarray
additionalPropertiesobject
defaultsstring
dependsOn
descriptionstring
displayNamestring
idstring
prefillstring
requiredboolean
typestring
Possible Values
STRINGSELECTINTFLOATBOOLDATETIMEDATETIMEDURATIONFILEJSONIONURISECRETARRAYMULTISELECTYAMLEMAILFORMREUSABLE_INPUTSUNKNOWN_DEFAULT_OPEN_API
labelsarray
keystring
valuestring
namespacestring
outputsarray
descriptionstring
displayNamestring
idstring
requiredboolean
typestring
Possible Values
STRINGSELECTINTFLOATBOOLDATETIMEDATETIMEDURATIONFILEJSONIONURISECRETARRAYMULTISELECTYAMLEMAILFORMREUSABLE_INPUTSUNKNOWN_DEFAULT_OPEN_API
value
retryobject
revisioninteger
slaarray
behaviorstring
Possible Values
FAILCANCELNONEUNKNOWN_DEFAULT_OPEN_API
idstring
labelsarray
keystring
valuestring
typestring
Possible Values
MAX_DURATIONEXECUTION_ASSERTIONUNKNOWN_DEFAULT_OPEN_API
tasksarray
additionalPropertiesobject
allowFailureboolean
allowWarningboolean
descriptionstring
disabledboolean
idstring
logLevelstring
Possible Values
ERRORWARNINFODEBUGTRACEUNKNOWN_DEFAULT_OPEN_API
logToFileboolean
retryobject
taskCache
enabledboolean
ttlstring
timeoutstring
typestring
versionstring
whenstring
workerSelector
fallbackstring
Possible Values
FAILWAITCANCELIGNORE
matchstring
Possible Values
ALLANY
tagsarray
SubTypestring
triggersarray
additionalPropertiesobject
allowConcurrentboolean
assets
enableAutostring
inputs
outputs
descriptionstring
disabledboolean
failOnTriggerErrorboolean
idstring
labelsarray
keystring
valuestring
logLevelstring
Possible Values
ERRORWARNINFODEBUGTRACEUNKNOWN_DEFAULT_OPEN_API
logToFileboolean
stopAfterarray
SubTypestring
Possible Values
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDUNKNOWN_DEFAULT_OPEN_API
typestring
versionstring
whenstring
workerSelector
fallbackstring
Possible Values
FAILWAITCANCELIGNORE
matchstring
Possible Values
ALLANY
tagsarray
SubTypestring
updatedstring
Formatdate-time
variablesobject
workerSelector
fallbackstring
Possible Values
FAILWAITCANCELIGNORE
matchstring
Possible Values
ALLANY
tagsarray
SubTypestring

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

109 tasks

2014 blueprints

R
R

Tasks that run R scripts.

Core

4 tasks