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
  • Copy
  • Fill window
List a limited number of Flux tasks
kapacitor flux task list --limit 20
  • Copy
  • Fill window
List a specific Flux task
kapacitor flux task list --id 000x00xX0xXXx00
  • Copy
  • Fill window

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

GET /kapacitor/v1/api/v2/tasks
  • Copy
  • Fill window

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'
  • Copy
  • Fill window
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"
  • Copy
  • Fill window
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"
  • Copy
  • Fill window
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"
  • Copy
  • Fill window
List only active Flux tasks
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks' \
  --header 'Content-Type: application/json' \
  --data-urlencode "status=active"
  • 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: