0604c12f27
* add api lock doc * add docs nav data * Update website/content/api-docs/system/namespaces.mdx Co-authored-by: Chris Capurso <christopher.capurso@gmail.com> * update command doc * clarify locked http status code * add example exempt path * further exempt clarification * link api locked response * add x-vault-namespace api example * Update website/content/docs/concepts/namespace-api-lock.mdx Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com> * review suggestions * few other small tweaks Co-authored-by: Chris Capurso <christopher.capurso@gmail.com> Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
81 lines
1.7 KiB
Plaintext
81 lines
1.7 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: namespace - Command
|
|
description: The "namespace" command groups subcommands for interacting with namespaces.
|
|
---
|
|
|
|
# namespace
|
|
|
|
The `namespace` command groups subcommands for interacting with namespaces.
|
|
|
|
## Examples
|
|
|
|
List all namespaces:
|
|
|
|
```shell-session
|
|
$ vault namespace list
|
|
```
|
|
|
|
Create a namespace at the path `ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace create ns1/
|
|
```
|
|
|
|
Delete the namespace at path `ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace delete ns1/
|
|
```
|
|
|
|
Lookup the namespace information at path `ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace lookup ns1/
|
|
```
|
|
|
|
Lock the API for the current namespace:
|
|
|
|
```shell-session
|
|
$ vault namespace lock
|
|
```
|
|
|
|
Lock the API for a descendant namespace at path `current/namespace/ns1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace lock ns1/
|
|
```
|
|
|
|
Unlock the API for the current namespace:
|
|
|
|
```shell-session
|
|
$ vault namespace unlock -unlock-key <unlock key>
|
|
```
|
|
|
|
Unlock the API for a descendant namespace at path `current/namespacens1/`:
|
|
|
|
```shell-session
|
|
$ vault namespace unlock -unlock-key <unlock key> ns1/
|
|
```
|
|
|
|
## Usage
|
|
|
|
```text
|
|
Usage: vault namespace <subcommand> [options] [args]
|
|
|
|
This command groups subcommands for interacting with Vault namespaces.
|
|
These set of subcommands operate on the context of the namespace that the
|
|
current logged in token belongs to.
|
|
|
|
Subcommands:
|
|
create Create a new namespace
|
|
delete Delete an existing namespace
|
|
list List child namespaces
|
|
lookup Look up an existing namespace
|
|
lock Lock the API for a namespace
|
|
unlock Unlock the API for a namespace
|
|
```
|
|
|
|
For more information, examples, and usage about a subcommand, click on the name
|
|
of the subcommand in the sidebar.
|