influx task create
The influx task create command creates a task in InfluxDB.
Usage
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, --orgor--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!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB Cloud Serverless and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.