Documentation

InfluxDB Cloud Serverless

influx template

  • influx CLI 2.0.1+

The influx template command summarizes the specified InfluxDB template. The command returns information about all resources included in the template.

Usage

influx template [flags]
influx template [command]

Subcommands

SubcommandDescription
validateValidate a template

Flags

FlagDescriptionInput TypeMaps to ?
--disable-colorDisable color in output
--disable-table-bordersDisable table borders
-e--encodingTemplate encoding (yaml,yml,json, or jsonnet)string
-f--filePath to template file (supports HTTP(S) URLs or file paths)stringArray
-h--helpHelp for the template command
--jsonOutput data as JSON (default false)INFLUX_OUTPUT_JSON
-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

Summarize InfluxDB Templates:

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

Was this page helpful?

Thank you for your feedback!

© 2025 InfluxData, Inc.

Select your InfluxDB Cloud Serverless region

Select your InfluxDB Cloud Serverless region and we’ll customize code examples for you.

AWS

For more information, see InfluxDB Cloud Serverless regions.

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

New in InfluxDB 3.5

Key enhancements in InfluxDB 3.5 and the InfluxDB 3 Explorer 1.3.

See the Blog Post

InfluxDB 3.5 is now available for both Core and Enterprise, introducing custom plugin repository support, enhanced operational visibility with queryable CLI parameters and manual node management, stronger security controls, and general performance improvements.

InfluxDB 3 Explorer 1.3 brings powerful new capabilities including Dashboards (beta) for saving and organizing your favorite queries, and cache querying for instant access to Last Value and Distinct Value caches—making Explorer a more comprehensive workspace for time series monitoring and analysis.

For more information, check out:

InfluxDB Docker latest tag changing to InfluxDB 3 Core

On February 3, 2026, the latest tag for InfluxDB Docker images will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments.

If using Docker to install and run InfluxDB, the latest tag will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments. For example, if using Docker to run InfluxDB v2, replace the latest version tag with a specific version tag in your Docker pull command–for example:

docker pull influxdb:2

InfluxDB Cloud Serverless

You are currently viewing documentation specific to InfluxDB Cloud Serverless powered by the v3 storage engine, which offers different functionality than InfluxDB Cloud powered by the TSM storage engine.

Are you using InfluxDB Cloud Serverless? How to find out?

Visit your organization's homepage and find the following at the bottom of the right column:

InfluxDB Cloud Serverless Storage Engine Version 3
Yes – I'm using InfluxDB Cloud Serverless No – I'm using InfluxDB Cloud (TSM)