Version: Development

namespace

The namespace command groups subcommands for interacting with namespaces.

Examples

List all namespaces:

$ bao namespace list

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

$ bao namespace list -detailed

Recursively list (scan) all namespaces:

$ bao namespace scan

Recursively list (scan) all namespaces with additional details such as namespace ID and custom metadata:

$ bao namespace scan -detailed

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

$ bao namespace create ns1/

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

$ bao 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

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

Delete the namespace at path ns1/:

$ bao namespace delete ns1/

Delete a sealed namespace with no child namespaces (requires sudo):

$ bao namespace delete-sealed ns1

Delete a sealed namespace and recursively wipe its child namespaces (requires sudo):

$ bao namespace delete-sealed -force ns1

Lookup the namespace information at path ns1/:

$ bao namespace lookup ns1/

Lock the API for the current namespace:

$ bao namespace lock

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

$ bao namespace lock ns1/

Unlock the API for the current namespace:

$ bao namespace unlock -unlock-key <unlock key>

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

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

Seal the namespace:

$ bao namespace seal

Unseal the namespace:

$ bao namespace unseal

Retrieve the namespace seal status:

$ bao namespace seal-status

Usage

Usage: bao namespace <subcommand> [options] [args]

  This command groups subcommands for interacting with OpenBao namespaces.

Subcommands:
    create         Create a new namespace
    delete         Delete an existing namespace
    delete-sealed  Delete a sealed namespace
    list           List child namespaces
    lock           Lock the API for particular namespaces
    lookup         Look up an existing namespace
    patch          Patch an existing namespace
    scan           List all (child) namespaces recursively
    seal           Seals the namespace
    seal-status    Prints the namespace seal status
    unlock         Unlock the API for particular namespaces
    unseal         Unseals the namespace

For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar.

Examples​

Usage​

Examples

Usage