influx template validate
- influx CLI 2.0.1+
- InfluxDB 2.0.1+
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 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
Related
- InfluxDB templates
- influx CLI—Provide required authentication credentials
- influx CLI—Flag patterns and conventions