Documentation

kapacitor list

The kapacitor list command lists tasks, templates, recordings, replays, topics, or handlers and their current state.

Usage

kapacitor list <resource-type> [<topic>] [<resource-id-or-pattern>]
  • Copy
  • Fill window

Arguments

  • resource-type: Resource type to list. The following resource are supported:

    • tasks
    • templates
    • recordings
    • replays
    • topics
    • topic-handlers
    • service-tests
  • topic: Topic to list handlers from. Only required when listing handlers.

  • resource-id-or-pattern: Resource ID or glob pattern to match resource IDs to list. If no resource ID or pattern is specified, all resources of the specified resource type are listed.

Examples

List all tasks

kapacitor list tasks
  • Copy
  • Fill window

List all tasks matching a glob pattern

kapacitor list tasks *_alert
  • Copy
  • Fill window

List a specific recording

kapacitor list recordings b0a2ba8a-aeeb-45ec-bef9-1a2939963586
  • Copy
  • Fill window

List all handlers in a topic

kapacitor list topic-handlers system
  • Copy
  • Fill window

List a specific handler in a topic

To list a handler, specify the topic before the handler ID or glob pattern.

kapacitor list topic-handlers system email
  • Copy
  • Fill window

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.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: