Kestra Plugin Toggle

Kestra Plugin Toggle

Certified

Enable or disable a trigger

Switches a trigger's enabled flag by flow/namespace filters. Defaults to current flow namespace.

yaml
type: io.kestra.plugin.kestra.triggers.Toggle

Toggle a trigger on flow input.

yaml
id: trigger_toggle
namespace: company.team

inputs:
  - id: toggle
    type: BOOL
    defaults: true

tasks:
  - id: if
    type: io.kestra.plugin.core.flow.If
    condition: "{{inputs.toggle}}"
    then:
      - id: enable
        type: io.kestra.plugin.kestra.triggers.Toggle
        trigger: schedule
        enabled: true
    else:
      - id: disable
        type: io.kestra.plugin.kestra.triggers.Toggle
        trigger: schedule
        enabled: false
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: Hello World

triggers:
  - id: schedule
    type: io.kestra.plugin.core.trigger.Schedule
    cron: "* * * * *"
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

Defaultfalse

Set trigger enabled

Defaults to false.

Flow id filter

Defaults to current flow id when null.

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 filter

Defaults to current flow namespace.

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.

Trigger id to toggle

Optional; when null and multiple triggers match, all are toggled.

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