Documentation

influx template validate

The influx template validate command validates the provided InfluxDB template.

Usage

influx template validate [flags]

Flags

Flag Description Input Type
-e --encoding Template encoding string
-f --file Path to template file (supports HTTP(S) URLs or file paths) stringArray
-h --help Help for the validate command
-R --recurse Recurse through files in the directory specified in -f, --file

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, --org or --org-id: InfluxDB organization name or ID
  • -t, --token: InfluxDB API token

Validate InfluxDB Templates:

Validate an InfluxDB template from a local file
influx template validate --file /path/to/template.yml
Validate InfluxDB templates from multiple files
influx template validate \
  --file /path/to/template1.yml \
  --file /path/to/template2.yml
Validate an InfluxDB template from a URL
influx template validate --file https://example.com/path/to/template.yml
Validate all InfluxDB templates in a directory
influx template validate \
  --file /path/to/template/dir/ \
  --recurse
Specify the encoding of the InfluxDB template to validate
influx template validate \
  --file /path/to/template \
  --encoding json

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

InfluxDB Cloud Serverless