namespace

The namespace command groups subcommands for interacting with namespaces.

Examples

List all namespaces:

$ vault namespace list

List all namespaces with additional details such as namespace ID and custom metadata:

$ vault namespace list -detailed

Create a namespace at the path ns1/ with no custom metadata:

$ vault namespace create ns1/

Create a namespace at the path ns1/ with multiple custom metadata keys:

$ vault namespace create -custom-metadata=foo=abc -custom-metadata=bar=123 ns1/

Patch an existing namespace at the path ns1/ to add custom metadata key bar and remove key foo

$ vault namespace patch -custom-metadata=bar=123 -remove-custom-metadata=foo ns1/

Delete the namespace at path ns1/:

$ vault namespace delete ns1/

Lookup the namespace information at path ns1/:

$ vault namespace lookup ns1/

Lock the API for the current namespace:

$ vault namespace lock

Lock the API for a descendant namespace at path current/namespace/ns1/:

$ vault namespace lock ns1/

Unlock the API for the current namespace:

$ vault namespace unlock -unlock-key <unlock key>

Unlock the API for a descendant namespace at path current/namespacens1/:

$ vault namespace unlock -unlock-key <unlock key> ns1/

Usage

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.