# vhsm path-help

The `vhsm path-help` command retrieves API help for vHSM paths. All vHSM endpoints provide built-in help in Markdown format, covering:

* System paths
* Secrets engines
* Authentication methods

This interactive help allows users to discover and understand paths available in vHSM.

### **Usage**

```
vhsm path-help <path>
```

* Retrieves API help for the given vHSM path.
* Helps discover and understand supported paths.

### **Examples**

| Action                                           | Command                          |
| ------------------------------------------------ | -------------------------------- |
| Get help output for the KV secrets engine        | `vhsm path-help secret`          |
| Learn more about a specific KV path (`password`) | `vhsm path-help secret/password` |

```sh
vhsm path-help secret
```

**Description**\
The KV backend reads and writes arbitrary secrets. vHSM encrypts/decrypts secrets, ensuring they are never stored unencrypted.

**Output**

```sh
## PATHS

The following paths are supported by this backend. To view help for
any of the paths below, use the help command with any route matching
the path pattern. Note that depending on the policy of your auth token,
you may or may not be able to access certain paths.

    ^.*$


    ^config$
        Configures settings for the KV store

    ^data/(?P<path>.*?[^/]$)$
        Write, Patch, Read, and Delete data in the Key-Value Store.

    ^delete/(?P<path>.*)$
        Marks one or more versions as deleted in the KV store.

    ^destroy/(?P<path>.*)$
        Permanently removes one or more versions in the KV store

    ^metadata/(?P<path>.*)$
        Configures settings for the KV store

    ^subkeys/(?P<path>.*)$
        Read the structure of a secret entry from the Key-Value store with the values removed.

    ^undelete/(?P<path>.*)$
        Undeletes one or more versions from the KV store.
```

To get help for a specific path, use:

```sh
vhsm path-help <path>
```

**Example for `password` path**

```sh
vhsm path-help secret/password
```

**Output**

```
Request:        password
Matching Route: ^.*$

<no synopsis>

```

***

### **Command Options**

| Option             | Description                               | Default |
| ------------------ | ----------------------------------------- | ------- |
| `-format=<format>` | Output format: `table`, `json`, or `yaml` | `table` |
| `-field=<name>`    | Print only a specific field in the output | `None`  |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.enclaive.cloud/virtual-hsm/cli/configuration-and-management/vhsm-path-help.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.