Documentation

influx task update

The influx task update command updates information related to tasks in InfluxDB.

Usage

influx task update [task literal] [flags]

Flags

FlagDescriptionInput typeMaps to ?
-c--active-configCLI configuration to use for commandstring
--configs-pathPath to influx CLI configurations (default ~/.influxdbv2/configs)stringINFLUX_CONFIGS_PATH
-f--filePath to Flux script filestring
-h--helpHelp for the update command
--hide-headersHide table headers (default false)INFLUX_HIDE_HEADERS
--hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
--http-debugInspect communication with InfluxDB servers.string
-i--id(Required) Task IDstring
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
--script-id(InfluxDB Cloud only) Invokable script ID to executestring
--script-params(InfluxDB Cloud only) Invokable script JSON parametersstring
--statusUpdate task status (active or inactive)string
-t--tokenAPI tokenstringINFLUX_TOKEN

Example

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

Update a task from a Flux string
export UPDATED_FLUX_TASK='
  option task = {
    name: "Example Task",
    every: 1d
  }

  from(bucket: "example-bucket")
    |> range(start: -task.every)
    |> filter(fn: (r) => r._measurement == "m")
    |> aggregateWindow(every: 1h, fn: mean)
    |> to(bucket: "default-ds-1d", org: "my-org")
'

influx task update \
  --id 0001234 \
  $UPDATED_FLUX_TASK
Update a task from a Flux file
influx task update \
  --id 0001234 \
  --file /path/to/example-task.flux
Update a task from a script ID
influx task update \
  --id 0001234 \
  --script-id 0004567
Enable a task
influx task update \
  --id 0001234 \
  --status active
Disable a task
influx task update \
  --id 0001234 \
  --status inactive

Was this page helpful?

Thank you for your feedback!


Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.