Kestra Plugin Kill

Kestra Plugin Kill

Certified

Kill a running execution

Terminates a non-finished execution and, by default, propagates the kill to child executions. Use on active states; already terminated executions are not affected.

yaml
type: io.kestra.plugin.kestra.executions.Kill

Kill the current execution with propagation to child executions

yaml
id: conditional-kill-flow
namespace: company.team

inputs:
  - id: shouldKill
    type: boolean
    defaults: false

tasks:
  - id: subflow
    type: io.kestra.plugin.core.flow.Subflow
    flowId: child
    namespace: company.team
    wait: false
  - id: kill
    type: io.kestra.plugin.kestra.executions.Kill
    runIf: "{{ inputs.shouldKill == true }}"
    executionId: "{{ execution.id }}"
    propagateKill: true
    auth:
      username: "{{ secret('KESTRA_USERNAME') }}"
      password: "{{ secret('KESTRA_PASSWORD') }}"

Kill a specific execution by ID. Use "{{ execution.id }}" to kill the current execution.

yaml
id: kill-specific-execution
namespace: company.team

tasks:
  - id: kill_execution
    type: io.kestra.plugin.kestra.executions.Kill
    executionId: "{{ vars.targetExecutionId }}"
    propagateKill: false
    kestraUrl: http://localhost:8080
    auth:
      username: "{{ secret('KESTRA_USERNAME') }}"
      password: "{{ secret('KESTRA_PASSWORD') }}"
Properties

Execution ID to kill

ID of the execution to kill; use {{ execution.id }} for the current one.

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.

Reference (ref) of the pluginDefaults to apply to this task.

Defaulttrue

Propagate kill to child executions

Defaults to true. When true, also kills subflow executions.

Override target tenant

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

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