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

  1. influx template validate [flags]

Flags

FlagDescriptionInput Type
-e—encodingTemplate encodingstring
-f—filePath to template file (supports HTTP(S) URLs or file paths)stringArray
-h—helpHelp for the validate command
-R—recurseRecurse 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
  1. influx template validate --file /path/to/template.yml
Validate InfluxDB templates from multiple files
  1. influx template validate \
  2. --file /path/to/template1.yml \
  3. --file /path/to/template2.yml
Validate an InfluxDB template from a URL
  1. influx template validate --file https://example.com/path/to/template.yml
Validate all InfluxDB templates in a directory
  1. influx template validate \
  2. --file /path/to/template/dir/ \
  3. --recurse
Specify the encoding of the InfluxDB template to validate
  1. influx template validate \
  2. --file /path/to/template \
  3. --encoding json