influx export stack
- influx CLI 2.0.0+
- InfluxDB 2.0.0+
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 export stack
command exports all resources associated with a stack as a template. All metadata.name
fields remain the same.
To export resources as a template, you must use the Operator token created for the initial InfluxDB user or an All-Access token. For information about creating an All-Access API token, see Create an API token.
Usage
influx export stack <stack_id> [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 | |
-f | —file | Template output file. Defaults to stdout. Use .yml or .json file extensions. | string | |
-h | —help | Help for the export stack command | ||
—host | HTTP address of InfluxDB (default http://localhost:8086 ) | string | INFLUX_HOST | |
—http-debug | Inspect communication with InfluxDB servers. | string | ||
-o | —org | Organization name that owns the resources (mutually exclusive with —org-id ) | string | INFLUX_ORG |
—org-id | Organization ID that owns the resources (mutually exclusive with —org ) | string | INFLUX_ORG_ID | |
—skip-verify | Skip TLS certificate verification | INFLUX_SKIP_VERIFY | ||
-t | —token | API token | string | INFLUX_TOKEN |
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
Export a stack as a template
influx export stack $STACK_ID