influx task create

  • influx CLI 2.0.0+
  • InfluxDB 2.0.0+
  • Updated in CLI v2.4.0

The influx task create command creates a task in InfluxDB.

Usage

1. influx task create [task literal] [flags]

Flags

Flag Description Input type Maps to ?
-c —active-config CLI configuration to use for command string
—configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
-r —cron (InfluxDB Cloud only) Cron expression to define when the task runs string
-e —every (InfluxDB Cloud only) Interval at which the task runs string
-f —file Path to Flux script file string
-h —help Help for the create command
—hide-headers Hide table headers (default false) INFLUX_HIDE_HEADERS
—host HTTP address of InfluxDB (default http://localhost:8086) string INFLUX_HOST
—http-debug Inspect communication with InfluxDB servers. string
—json Output data as JSON (default false) INFLUX_OUTPUT_JSON
-n —name (InfluxDB Cloud only) Task name string
-o —org Organization name (mutually exclusive with —org-id) string INFLUX_ORG
—org-id Organization ID (mutually exclusive with —org) string INFLUX_ORG_ID
—skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
—script-id (InfluxDB Cloud only) Invokable script ID to execute string
—script-params (InfluxDB Cloud only) Invokable script JSON parameters string
-t —token API token string INFLUX_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
1. export FLUX_TASK='
2. option task = {
3. name: "Example Task",
4. every: 1d
5. }

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

14. influx task create $FLUX_TASK
Create a task from a file
1. influx task create --file /path/to/example-task.flux
Create a task using an invokable script
1. influx task create \
2. --name "my task" \
3. --every "10h" \
4. --script-id 0001234