influx scripts invoke
This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.
The influx scripts invoke command executes an invokable script in InfluxDB.
Usage
influx scripts invoke [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 | |
-f | --file | File name containing the script parameters, in JSON | string | |
-h | --help | Help for the delete 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 | ||
-p | --params | JSON string containing script parameters | string | |
-i | --scriptID | (Required) Script ID | string | |
--skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | --token | API token | string | INFLUX_TOKEN |
Examples
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
Invoke a script
influx scripts invoke -i 0Xx0oox00XXoxxoo1
Invoke a script with parameters
influx scripts invoke \
-i 0Xx0oox00XXoxxoo1 \
-p "{ \"myParameter\": \"example-data\" }"
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 and this documentation. To find support, use the following resources:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.