Quickwit Toggle
CertifiedToggle a Quickwit source
Quickwit Toggle
Toggle a Quickwit source
Enables or disables a source. A disabled source stops indexing without losing its checkpoint, so re-enabling it resumes where it left off. Quickwit answers with an empty body, which is expected.
type: io.kestra.plugin.quickwit.source.ToggleExamples
Pause an ingestion pipeline during a maintenance window
id: quickwit_toggle_source
namespace: company.team
tasks:
- id: pause
type: io.kestra.plugin.quickwit.source.Toggle
url: "http://localhost:7280"
index: app-logs
source: kafka-source
enable: false
- id: resume
type: io.kestra.plugin.quickwit.source.Toggle
url: "http://localhost:7280"
index: app-logs
source: kafka-source
enable: true
Properties
index *string
Index ID
ID of the index the source belongs to.
source *string
Source ID
ID of the source, unique within its index. See the source ID validation rules.
url *string
Quickwit URL
Base URL of the Quickwit REST API, including the scheme. The api/v1 prefix is added automatically.
A local node listens on port 7280, e.g. http://localhost: 7280.
assets
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150basicAuth
Basic authentication
Optional HTTP basic authentication credentials.
Quickwit itself has no authentication layer, so this is only needed when the cluster sits behind a reverse proxy or an API gateway that enforces basic auth.
io.kestra.plugin.quickwit.AbstractQuickwitTask-BasicAuth
Password
Password for HTTP basic authentication.
Username
Username for HTTP basic authentication.
connectTimeout string
Connect timeout
Maximum time to wait to establish a connection to Quickwit, e.g. PT10S.
When unset, the default of the underlying HTTP client applies.
enable booleanstring
Enable
true to let Quickwit index from this source, false to stop indexing without deleting its checkpoint.
headers object
Custom HTTP headers
Headers sent on every request, for example an Authorization: Bearer ... token or a gateway API key.
Quickwit itself has no authentication layer, so this is only needed when the cluster sits behind an API gateway that injects credentials.
readTimeout string
Read timeout
Maximum time to keep waiting for data on an idle connection, e.g. PT5M.
A commit=force ingest or a large search may legitimately take a while, so raise it when needed.
Outputs
enable boolean
Enabled
true when the source was enabled, false when it was disabled.
index string
Index ID
ID of the index the source belongs to.
source string
Source ID
ID of the source that was toggled.
