open-vault/website/source/docs/http/sys-init.html.md

layout	page_title	sidebar_current	description
http	HTTP API: /sys/init	docs-http-sys-init	The '/sys/init' endpoint is used to initialize a new Vault.

/sys/init

GET

Description

Return the initialization status of a Vault.

<dt>Method</dt>
<dd>GET</dd>

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

<dt>Returns</dt>
<dd>

{
	"initialized": false
}

</dd>

PUT

Description

Initializes a new Vault. The Vault must've not been previously initialized.

<dt>Method</dt>
<dd>PUT</dd>

<dt>Parameters</dt>
<dd>
	<ul>
		<li>
			<span class="param">secret_shares</span>
			<span class="param-flags">required</span>
			The number of shares to split the master key into.
		</li>
		<li>
			<span class="param">secret_threshold</span>
			<span class="param-flags">required</span>
			The number of shares required to reconstruct the master key.
			This must be less than or equal to <code>secret_shares</code>.
		</li>
	</ul>
</dd>

<dt>Returns</dt>
<dd>
	A JSON-encoded object including the master keys and initial root token:

{
	"keys": ["one", "two", "three"],
	"root_token": "foo"
}

</dd>