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"

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.