Documentation

Update Kapacitor Flux tasks

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

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

* Required

  • * -i, --id: Task ID
  • --status: Updated tasks status (active or inactive)
  • -f, --file: Path to updated Flux script file

Examples

Update Flux task code
kapacitor flux task update \
  --id 000x00xX0xXXx00 \
  --file /path/to/updated-task.flux
  • Copy
  • Fill window
Enable or disable a Flux task
kapacitor flux task update \
  --id 000x00xX0xXXx00 \
  --status inactive
  • Copy
  • Fill window

Use the following request method and endpoint to update a new Kapacitor Flux task.

PATCH /kapacitor/v1/api/v2/tasks/{taskID}
  • Copy
  • Fill window

Provide the following with your request (* Required):

Headers

  • * Content-type: application/json

Path parameters

  • * taskID: Task ID to update

Request body

JSON object with the following schema:

  • cron: Override the cron Flux task option
  • description: New task description
  • every: Override the every Flux task option
  • flux: New Flux task code
  • name: Override the name Flux task option
  • offset: Override the offset Flux task option
  • status: New Flux task status (active or inactive)

API Examples

The following examples use the task ID 000x00xX0xXXx00.

Update Flux task code
curl --request PATCH 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "flux": "option task = {name: \"Updated task name\", every: 1h}\n\nhost = \"http://localhost:8086\"\ntoken = \"\"\n\nfrom(bucket: \"db/rp\", host:host, token:token)\n\t|> range(start: -1h)\n\t|> filter(fn: (r) =>\n\t\t(r._measurement == \"cpu\"))\n\t|> filter(fn: (r) =>\n\t\t(r._field == \"usage_system\"))\n\t|> filter(fn: (r) =>\n\t\t(r.cpu == \"cpu-total\"))\n\t|> aggregateWindow(every: 1h, fn: max)\n\t|> to(bucket: \"cpu_usage_user_total_1h\", host:host, token:token)"
}'
  • Copy
  • Fill window
Enable or disable a Flux task
curl --request PATCH 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00' \
  --header 'Content-Type: application/json' \
  --data-raw '{"status": "inactive"}'
  • Copy
  • Fill window
Override Flux task options
curl --request PATCH 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "every": "1d",
    "name": "New task name",
    "offset": "15m"
}'
  • 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

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: