open-vault/website/source/docs/http/sys-mounts.html.md
2015-04-20 11:51:09 -07:00

1.4 KiB

layout page_title sidebar_current description
http HTTP API: /sys/mounts docs-http-mounts-mounts The '/sys/mounts' endpoint is used manage secret backends in Vault.

/sys/mounts

GET

Description
Lists all the mounted secret backends.
<dt>Method</dt>
<dd>GET</dd>

<dt>Parameters</dt>
<dd>
	None
</dd>

<dt>Returns</dt>
<dd>
{
	"aws": {
		"type": "aws",
		"description": "AWS keys"
	},

	"sys": {
		"type": "system",
		"description": "system endpoint"
	}
}
</dd>

POST

Description
Mount a new secret backend to the mount point in the URL.
<dt>Method</dt>
<dd>POST</dd>

<dt>URL</dt>
<dd>`/sys/mounts/<mount point>`</dd>

<dt>Parameters</dt>
<dd>
	<ul>
		<li>
			<span class="param">type</span>
			<span class="param-flags">required</span>
			The name of the backend type, such as "aws"
		</li>
		<li>
			<span class="param">description</span>
			<span class="param-flags">optional</span>
			A human-friendly description of the mount.
		</li>
	</ul>
</dd>

<dt>Returns</dt>
<dd>`204` response code.
</dd>

DELETE

Description
Unmount the mount point specified in the URL.
<dt>Method</dt>
<dd>DELETE</dd>

<dt>URL</dt>
<dd>`/sys/mounts/<mount point>`</dd>

<dt>Parameters</dt>
<dd>None
</dd>

<dt>Returns</dt>
<dd>`204` response code.
</dd>