Documentation

kapacitor define-template

The kapacitor define-template command creates or updates a template. A template is defined using a TICKscript that contains the data processing pipeline of the template.

Updating a template reloads all associated tasks.

Usage

kapacitor define-template <template-id> [flags]

Arguments

  • template-id: Unique identifier for the template

Flags

FlagDescription
-tickTICKscript filepath
-typeTemplate type (stream or batch)

Examples

Create a new template for stream tasks

When creating a new template, you must provide a template ID, TICKscript, and template type.

kapacitor define-template my-template \
  -tick /path/to/TICKscript.tick \
  -type stream

Create a new template for batch tasks

When creating a new template, you must provide a template ID, TICKscript, and template type.

kapacitor define-template my-template \
  -tick /path/to/TICKscript.tick \
  -type batch

Update a template’s TICKscript

kapacitor define-template existing-template \
  -tick /path/to/new_TICKscript.tick 

Update a template’s type

kapacitor define-template existing-template -type batch

Was this page helpful?

Thank you for your feedback!


Telegraf Enterprise now in public beta

Get early access to the Telegraf Controller and provide feedback to help shape the future of Telegraf Enterprise.

See the Blog Post

The upcoming Telegraf Enterprise offering is for organizations running Telegraf at scale and is comprised of two key components:

  • Telegraf Controller: A control plane (UI + API) that centralizes Telegraf configuration management and agent health visibility.
  • Telegraf Enterprise Support: Official support for Telegraf Controller and Telegraf plugins.

Join the Telegraf Enterprise beta to get early access to the Telegraf Controller and provide feedback to help shape the future of Telegraf Enterprise.

For more information:

InfluxDB Docker latest tag changing to InfluxDB 3 Core

On May 27, 2026, the latest tag for InfluxDB Docker images will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments.

If using Docker to install and run InfluxDB, the latest tag will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments. For example, if using Docker to run InfluxDB v2, replace the latest version tag with a specific version tag in your Docker pull command–for example:

docker pull influxdb:2