Documentation

influx scripts invoke

The influx scripts invoke command executes an invokable script in InfluxDB.

Usage

influx scripts invoke [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--fileFile name containing the script parameters, in JSONstring
-h--helpHelp for the delete 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
-p--paramsJSON string containing script parametersstring
-i--scriptID(Required) Script IDstring
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
-t--tokenAPI tokenstringINFLUX_TOKEN

Examples

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.

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!


Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.