2017-01-05 00:24:09 +00:00
|
|
|
---
|
2020-09-01 15:14:13 +00:00
|
|
|
layout: commands
|
2020-04-07 18:55:19 +00:00
|
|
|
page_title: 'Commands: KV Export'
|
2017-01-05 00:24:09 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Consul KV Export
|
|
|
|
|
|
|
|
Command: `consul kv export`
|
|
|
|
|
2017-04-04 16:33:22 +00:00
|
|
|
The `kv export` command is used to retrieve KV pairs for the given
|
|
|
|
prefix from Consul's KV store, and write a JSON representation to
|
2017-01-05 00:24:09 +00:00
|
|
|
stdout. This can be used with the command "consul kv import" to move entire
|
|
|
|
trees between Consul clusters.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2018-11-07 01:14:12 +00:00
|
|
|
Usage: `consul kv export [options] [PREFIX]`
|
2017-01-05 00:24:09 +00:00
|
|
|
|
|
|
|
#### API Options
|
|
|
|
|
2020-04-07 18:55:19 +00:00
|
|
|
@include 'http_api_options_client.mdx'
|
2020-04-07 23:56:08 +00:00
|
|
|
|
2020-04-07 18:55:19 +00:00
|
|
|
@include 'http_api_options_server.mdx'
|
2017-01-05 00:24:09 +00:00
|
|
|
|
2019-12-06 16:14:56 +00:00
|
|
|
#### Enterprise Options
|
|
|
|
|
2020-04-07 18:55:19 +00:00
|
|
|
@include 'http_api_namespace_options.mdx'
|
2019-12-06 16:14:56 +00:00
|
|
|
|
2021-12-15 01:55:21 +00:00
|
|
|
@include 'http_api_partition_options.mdx'
|
|
|
|
|
2017-01-05 00:24:09 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
To export the tree at "vault/" in the key value store:
|
|
|
|
|
2020-05-19 18:32:38 +00:00
|
|
|
```shell-session
|
2017-01-05 00:24:09 +00:00
|
|
|
$ consul kv export vault/
|
|
|
|
# JSON output
|
|
|
|
```
|