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>]

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

List all tasks matching a glob pattern

kapacitor list tasks *_alert

List a specific recording

kapacitor list recordings b0a2ba8a-aeeb-45ec-bef9-1a2939963586

List all handlers in a topic

kapacitor list topic-handlers system

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

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