Documentation

influx apply

The influx apply command applies InfluxDB templates. For information about finding and using InfluxDB templates, see Use InfluxDB templates.

Usage

influx apply [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
--disable-colorDisable color in output
--disable-table-bordersDisable table borders
-e--encodingEncoding of the input streamstring
--env-refEnvironment references to provide with the template (format: --env-ref=REF_KEY=REF_VALUE)string
-f--filePath to template file (supports HTTP(S) URLs or file paths)string
--filterResources to skip when applying the template (filter by kind or resource)string
--forceIgnore warnings about destructive changes
-h--helpHelp for the apply command
--hostHTTP address of InfluxDB (default http://localhost:8086)stringINFLUX_HOST
--http-debugInspect communication with InfluxDB servers.string
--jsonOutput data as JSONINFLUX_OUTPUT_JSON
-o--orgOrganization name that owns the bucket (mutually exclusive with --org-id)stringINFLUX_ORG
--org-idOrganization ID that owns the bucket (mutually exclusive with --org)stringINFLUX_ORG_ID
-q--quietDisable output printing
-R--recurseRecurse through files in the directory specified in -f, --file
--secretSecrets to provide with the template (format: --secret=SECRET_KEY=SECRET_VALUE)string
--skip-verifySkip TLS certificate verificationINFLUX_SKIP_VERIFY
--stack-idStack ID to associate when applying the templatestring
-t--tokenAPI tokenstringINFLUX_TOKEN

Examples: how to apply a template or stack

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
Apply a template from a file
influx apply --file path/to/template.json
Apply a template from a URL
influx apply --file https://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
Apply a stack that has associated templates

To apply all templates associated with a stack ID to a new stack:

influx apply --stack-id $STACK_ID
Apply a template to a stack
influx apply --file path/to/template.json --stack-id $STACK_ID
Apply multiple template files together
influx apply \
  --file path/to/template_1.json \
  --file path/to/template_2.yml
Apply a template from stdin
cat template.json | influx apply --encoding json
Apply all templates in a directory
influx apply --file path/to/template_directory
Recursively apply templates from a directory
influx apply --recurse --file path/to/template_directory
Apply templates from multiple sources
influx apply \
  --file path/to/template.yml
  --file path/to/templates_directory
  --file https://example.com/template.json
Apply a template, but skip resources
# The following example skips all buckets and the dashboard
# whose metadata.name field matches "example-dashboard".

# Filter format:
#	--filter=kind=Bucket
#	--filter=resource=Label:$Label_TMPL_NAME

influx apply \
	--file path/to/template.yml \
	--filter kind=Bucket \
	--filter resource=Dashboard:example-dashboard

Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.