Documentation

List Kapacitor Flux tasks

Use the kapacitor CLI or the Kapacitor HTTP API to list Kapacitor Flux tasks.

Use the kapacitor flux task list command to list Kapacitor Flux tasks. Provide the following flags:

  • -i, --id: Filter by task ID
  • --limit: Limit the number of returned tasks (default is 500)

CLI examples

List all Flux tasks
kapacitor flux task list
List a limited number of Flux tasks
kapacitor flux task list --limit 20
List a specific Flux task
kapacitor flux task list --id 000x00xX0xXXx00

Use the following request method and endpoint to list Kapacitor Flux tasks.

GET /kapacitor/v1/api/v2/tasks

Provide the following with your request (* Required):

Headers

  • * Content-type: application/json

Query parameters

  • after: List tasks after a specific task ID
  • limit: Limit the number of tasks returned (default is 500)
  • name: Filter tasks by name
  • status: Filter tasks by status (active or inactive)

API examples

List all Flux tasks
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks' \
  --header 'Content-Type: application/json'
List a limited number of Flux tasks
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks' \
  --header 'Content-Type: application/json' \
  --data-urlencode "limit=1"
List a specific Flux task by name
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks' \
  --header 'Content-Type: application/json' \
  --data-urlencode "name=example-flux-task-name"
List Flux tasks after a specific task ID
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks' \
  --header 'Content-Type: application/json' \
  --data-urlencode "after=000x00xX0xXXx00"
List only active Flux tasks
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks' \
  --header 'Content-Type: application/json' \
  --data-urlencode "status=active"

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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: