List

List Kestra Namespaces

Retrieves a list of Kestra namespaces, offering options for filtering by prefix, pagination, and excluding non-existent namespaces.

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

Examples

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: Admin1234 # 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: Admin1234 # 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: Admin1234 # pass your Kestra password as secret or KV pair
    # No 'page' or 'size' properties to fetch all

Properties

auth AbstractKestraTask-Auth

Authentication information.

existingOnly booleanstring

Default false

Return only existing namespace

Set to true, namespaces that exists only because a flow is using it will not be returned.

kestraUrl string

Kestra API URL. If null, uses 'kestra.url' from configuration. If that is also null, defaults to 'http://localhost: 8080'.

page integerstring

If not provided, every pages are fetched

For example, set to 1, it can be used to only fetch the first 10 results used with size.

prefix string

The namespace prefix, if null, all namespaces will be listed.

size integerstring

Default 10

The number of namespaces to return per page.

tenantId string

The tenant ID to use for the request, defaults to current tenant.

Outputs

namespaces array

SubType string

A list of Kestra namespaces.

Definitions

io.kestra.plugin.kestra.AbstractKestraTask-Auth

apiToken string

API token.

password string

Password for HTTP Basic authentication.

username string

Username for HTTP Basic authentication.

​List

List