Documentation

kapacitor CLI

The kapacitor CLI interacts with and manages the Kapacitor server.

Usage

kapacitor [command] [flags] [args]

Commands

CommandDescription
backupBackup the Kapacitor database
defineCreate or update a task
define-templateCreate or update a template
define-topic-handlerCreate or update an alert handler for a topic
deleteDelete Kapacitor resources
disableDisable a task
enableEnable a task
fluxManage Kapacitor Flux tasks
helpPrint help for a command
levelSet the logging level on the kapacitord server
listList information about Kapacitor resources
logsOutput Kapacitor logs
recordRecord the results of a task or query
reloadReload a task with an updated task definition
replayReplay a recording to a task
replay-liveReplay data to a task without recording it
service-testsRun service tests
showDisplay information about a task
show-templateDisplay information about a template
show-topicDisplay information about an alert topic
show-topic-handlerDisplay information about an alert handler for a topic
statsDisplay Kapacitor server statistics
varsPrint Kapacitor debug vars in JSON format
versionDisplay the Kapacitor version
watchWatch logs for a task

Flags

FlagDescriptionEnvironment variable
-skipVerifyDisable SSL or TLS verificationKAPACITOR_UNSAFE_SSL
-urlURL of the kapacitord server (default is http://localhost:9092)KAPACITOR_URL

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: