94 lines
2 KiB
Markdown
94 lines
2 KiB
Markdown
---
|
|
layout: "http"
|
|
page_title: "HTTP API: /sys/init"
|
|
sidebar_current: "docs-http-sys-init"
|
|
description: |-
|
|
The '/sys/init' endpoint is used to initialize a new Vault.
|
|
---
|
|
|
|
# /sys/init
|
|
|
|
## GET
|
|
|
|
<dl>
|
|
<dt>Description</dt>
|
|
<dd>
|
|
Return the initialization status of a Vault.
|
|
</dd>
|
|
|
|
<dt>Method</dt>
|
|
<dd>GET</dd>
|
|
|
|
<dt>Parameters</dt>
|
|
<dd>None</dd>
|
|
|
|
<dt>Returns</dt>
|
|
<dd>
|
|
|
|
```javascript
|
|
{
|
|
"initialized": true
|
|
}
|
|
```
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
## PUT
|
|
|
|
<dl>
|
|
<dt>Description</dt>
|
|
<dd>
|
|
Initializes a new Vault. The Vault must've not been previously
|
|
initialized.
|
|
</dd>
|
|
|
|
<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>
|
|
<li>
|
|
<span class="param">pgp_keys</span>
|
|
<span class="param-flags">optional</span>
|
|
An array of PGP public keys used to encrypt the output unseal keys.
|
|
Ordering is preserved. The keys must be base64-encoded from their
|
|
original binary representation. The size of this array must be the
|
|
same as <code>secret_shares</code>.
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
|
|
<dt>Returns</dt>
|
|
<dd>
|
|
A JSON-encoded object including the (possibly encrypted, if
|
|
<code>pgp_keys</code> was provided) master keys and initial root token:
|
|
|
|
```javascript
|
|
{
|
|
"keys": ["one", "two", "three"],
|
|
"root_token": "foo"
|
|
}
|
|
```
|
|
|
|
</dd>
|
|
|
|
<dt>See Also</dt>
|
|
<dd>
|
|
For more information on the PGP/Keybase.io process please see the
|
|
[Vault GPG and Keybase integration documentation](/docs/concepts/pgp-gpg-keybase.html).
|
|
</dd>
|
|
</dl>
|