Kestra Plugin List

Kestra Plugin List

Certified

List namespaces with paging

Retrieves namespaces filtered by prefix with optional pagination. When page is null, iterates all pages. Defaults: size 10, existingOnly false.

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

List all namespaces with pagination

yaml
id: list_paginated_namespaces
namespace: company.team

tasks:
  - id: list_namespaces_paged
    type: io.kestra.plugin.kestra.namespaces.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
    page: 1
    size: 20

List only existing namespaces starting with 'dev.'

yaml
id: list_filtered_namespaces
namespace: company.team

tasks:
  - id: list_dev_namespaces
    type: io.kestra.plugin.kestra.namespaces.List
    kestraUrl: https://cloud.kestra.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: mytenant
    prefix: dev.
    existingOnly: true

List all namespaces without pagination (fetch all pages)

yaml
id: list_all_namespaces
namespace: company.team

tasks:
  - id: fetch_all_namespaces
    type: io.kestra.plugin.kestra.namespaces.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
    # No 'page' or 'size' properties to fetch all
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

Defaultfalse

Existing namespaces only

Defaults to false. When true, returns namespaces backed by stored definition, excluding transient ones.

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.

Page number

When null, fetches every page. Set with size to limit requests.

Namespace prefix

Defaults to empty string to return all namespaces.

Default10

Page size

Defaults to 10.

Override target tenant

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

SubTypestring

A list of Kestra namespaces