fe2f650240
* ACL * ACL * Catalog * consul config * consul connect * top-level updates * consul intention * consul kv * consul namespace * consul peering * consul peering delete * consul services * consul snapshot * consul tls * consul acl auth-method * acl binding-rule * acl policy * acl role * acl token * fix * standardization * Update website/content/commands/snapshot/save.mdx Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> * consul debug consul keyring Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
49 lines
1.2 KiB
Plaintext
49 lines
1.2 KiB
Plaintext
---
|
|
layout: commands
|
|
page_title: 'Commands: KV Export'
|
|
description: >-
|
|
The `consul kv export` command outputs KV pairs from Consul's key/value store in JSON to move trees between Consul clusters.
|
|
---
|
|
|
|
# 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](/consul/api-docs/api-structure#authentication). Configuration of
|
|
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/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
|
|
```
|