open-consul/website/content/commands/kv/import.mdx
Blake Covarrubias 48b90fb448 docs: Add version callout for kv import -prefix
Add a sentence stating the version of Consul that introduced the
`-prefix` option for `consul kv import`.

Resolves #10172
2021-07-26 09:45:24 -07:00

62 lines
1.1 KiB
Plaintext

---
layout: commands
page_title: 'Commands: KV Import'
---
# Consul KV Import
Command: `consul kv import`
The `kv import` command is used to import KV pairs from the JSON representation
generated by the `kv export` command.
## Usage
Usage: `consul kv import [options] [DATA]`
#### API Options
@include 'http_api_options_client.mdx'
@include 'http_api_options_server.mdx'
#### KV Import Options
- `-prefix` - Key prefix for imported data. The default value is empty meaning
root. Added in Consul 1.10.
#### Enterprise Options
@include 'http_api_namespace_options.mdx'
## Examples
To import from a file, prepend the filename with `@`:
```shell-session
$ consul kv import @values.json
# Output
```
To import from stdin, use `-` as the data parameter:
```shell-session
$ cat values.json | consul kv import -
# Output
```
You can also pass the JSON directly, however care must be taken with shell
escaping:
```shell-session
$ consul kv import "$(cat values.json)"
# Output
```
To import under prefix, use `-prefix` option:
```shell-session
$ cat values.json | consul kv import -prefix=sub/dir/ -
# Output
```