Documentation

Update a task

This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version. View this page in the v2.6 documentation.

Update a task in the InfluxDB UI

  1. In the navigation menu on the left, select Tasks.

  2. Find the task you would like to edit and click the icon located far right of the task name.

  3. Click Edit.

  4. Click Save in the upper right.

Update a task Flux script

  1. In the list of tasks, click the Name of the task you want to update.
  2. In the left panel, modify the task options.
  3. In the right panel, modify the task script.
  4. Click Save in the upper right.

Update the status of a task

In the list of tasks, click the toggle to the left of the task you want to activate or inactivate.

Update a task description

  1. In the list of tasks, hover over the name of the task you want to update.
  2. Click the pencil icon .
  3. Click outside of the field or press RETURN to update.

Update a task with the influx CLI

Use the influx task update command to update or change the status of an existing task.

This command requires a task ID, which is available in the output of influx task list.

Update a task Flux script

Pass the file path of your updated Flux script to the influx task update command with the ID of the task you want to update. Modified task options defined in the Flux script are also updated.

# Syntax
influx task update -i <task-id> -f </path/to/updated-task-script>
# Example
influx task update -i 0343698431c35000 -f /tasks/cq-mean-1h.flux

Update the status of a task

Pass the ID of the task you want to update to the influx task update command with the --status flag.

Possible arguments of the --status flag are active or inactive.

# Syntax
influx task update -i <task-id> --status < active | inactive >
# Example
influx task update -i 0343698431c35000 --status inactive

Update a task with the InfluxDB API

Use the /tasks/TASK_ID InfluxDB API endpoint to update properties of a task.

PATCH http://localhost:8086/api/v2/tasks/TASK_ID

In your request, pass the task ID and an object that contains the updated key-value pairs. To activate or inactivate a task, set the status property. "status": "inactive" cancels scheduled runs and prevents manual runs of the task. To find the task ID, see how to view tasks.

Once InfluxDB applies the update, it cancels all previously scheduled runs of the task.


Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.