mirror of
https://github.com/status-im/consul.git
synced 2025-01-10 05:45:46 +00:00
85c1a33c42
Co-authored-by: Ashlee Boyer <ashlee.boyer@hashicorp.com> Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@gmail.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com> Co-authored-by: Kevin Wang <kwangsan@gmail.com>
47 lines
1.0 KiB
Plaintext
47 lines
1.0 KiB
Plaintext
---
|
|
layout: commands
|
|
page_title: 'Commands: KV Export'
|
|
---
|
|
|
|
# Consul KV Export
|
|
|
|
Command: `consul kv export`
|
|
|
|
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
|
|
stdout. This can be used with the command "consul kv import" to move entire
|
|
trees between Consul clusters.
|
|
|
|
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
|
|
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
|
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
|
|
|
| ACL Required |
|
|
| ------------ |
|
|
| `key:read` |
|
|
|
|
## Usage
|
|
|
|
Usage: `consul kv export [options] [PREFIX]`
|
|
|
|
#### Enterprise Options
|
|
|
|
@include 'http_api_partition_options.mdx'
|
|
|
|
@include 'http_api_namespace_options.mdx'
|
|
|
|
#### API Options
|
|
|
|
@include 'http_api_options_client.mdx'
|
|
|
|
@include 'http_api_options_server.mdx'
|
|
|
|
## Examples
|
|
|
|
To export the tree at "vault/" in the key value store:
|
|
|
|
```shell-session
|
|
$ consul kv export vault/
|
|
# JSON output
|
|
```
|