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

Flag Description Input Type Maps to ?
-c --active-config CLI configuration to use for command string
--configs-path Path to influx CLI configurations (default ~/.influxdbv2/configs) string INFLUX_CONFIGS_PATH
--disable-color Disable color in output
--disable-table-borders Disable table borders
-e --encoding Encoding of the input stream string
--env-ref Environment references to provide with the template (format: --env-ref=REF_KEY=REF_VALUE) string
-f --file Path to template file (supports HTTP(S) URLs or file paths) string
--filter Resources to skip when applying the template (filter by kind or resource) string
--force Ignore warnings about destructive changes
-h --help Help for the apply command
--host HTTP address of InfluxDB (default http://localhost:8086) string INFLUX_HOST
--http-debug Inspect communication with InfluxDB servers. string
--json Output data as JSON INFLUX_OUTPUT_JSON
-o --org Organization name that owns the bucket (mutually exclusive with --org-id) string INFLUX_ORG
--org-id Organization ID that owns the bucket (mutually exclusive with --org) string INFLUX_ORG_ID
-q --quiet Disable output printing
-R --recurse Recurse through files in the directory specified in -f, --file
--secret Secrets to provide with the template (format: --secret=SECRET_KEY=SECRET_VALUE) string
--skip-verify Skip TLS certificate verification INFLUX_SKIP_VERIFY
--stack-id Stack ID to associate when applying the template string
-t --token API token string INFLUX_TOKEN

Examples: how to apply a template or stack

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

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

Select your region

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.