Documentation

influx task create

The influx task create command creates a task in InfluxDB.

Usage

influx task create [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
-r--cron(InfluxDB Cloud only) Cron expression to define when the task runsstring
-e--every(InfluxDB Cloud only) Interval at which the task runsstring
-f--filePath to Flux script filestring
-h--helpHelp for the create 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
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-n--name(InfluxDB Cloud only) Task namestring
-o--orgOrganization name (mutually exclusive with --org-id)stringINFLUX_ORG
--org-idOrganization ID (mutually exclusive with --org)stringINFLUX_ORG_ID
--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
-t--tokenAPI tokenstringINFLUX_TOKEN

Example

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by either the active influx CLI configuration or by environment variables (INFLUX_HOST, INFLUX_ORG, and INFLUX_TOKEN). If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

  • --host: InfluxDB host
  • -o, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token
Create a task using raw Flux
export 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 create $FLUX_TASK
Create a task from a file
influx task create --file /path/to/example-task.flux
Create a task using an invokable script
influx task create \
  --name "my task" \
  --every "10h" \
  --script-id 0001234

Was this page helpful?

Thank you for your feedback!


Select your region

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.

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.

InfluxDB Cloud powered by TSM