2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2020-01-18 00:18:09 +00:00
|
|
|
|
layout: api
|
|
|
|
|
page_title: /sys/init - HTTP API
|
|
|
|
|
description: The `/sys/init` endpoint is used to initialize a new Vault.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/init`
|
|
|
|
|
|
|
|
|
|
The `/sys/init` endpoint is used to initialize a new Vault.
|
|
|
|
|
|
|
|
|
|
## Read Initialization Status
|
|
|
|
|
|
|
|
|
|
This endpoint returns the initialization status of Vault.
|
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :---------- |
|
|
|
|
|
| `GET` | `/sys/init` |
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-03-15 06:40:33 +00:00
|
|
|
|
$ curl \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/init
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"initialized": true
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Start Initialization
|
|
|
|
|
|
|
|
|
|
This endpoint initializes a new Vault. The Vault must not have been previously
|
|
|
|
|
initialized. The recovery options, as well as the stored shares option, are only
|
2021-10-06 20:35:35 +00:00
|
|
|
|
available when using Auto Unseal.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
2020-01-18 00:18:09 +00:00
|
|
|
|
| Method | Path |
|
|
|
|
|
| :----- | :---------- |
|
2022-02-25 14:52:24 +00:00
|
|
|
|
| `POST` | `/sys/init` |
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `pgp_keys` `(array<string>: nil)` – Specifies 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 `secret_shares`.
|
|
|
|
|
|
|
|
|
|
- `root_token_pgp_key` `(string: "")` – Specifies a PGP public key used to
|
|
|
|
|
encrypt the initial root token. The key must be base64-encoded from its
|
|
|
|
|
original binary representation.
|
|
|
|
|
|
|
|
|
|
- `secret_shares` `(int: <required>)` – Specifies the number of shares to
|
|
|
|
|
split the master key into.
|
|
|
|
|
|
|
|
|
|
- `secret_threshold` `(int: <required>)` – Specifies the number of shares
|
|
|
|
|
required to reconstruct the master key. This must be less than or equal
|
|
|
|
|
`secret_shares`. If using Vault HSM with auto-unsealing, this value must be
|
|
|
|
|
the same as `secret_shares`.
|
|
|
|
|
|
2021-10-06 20:35:35 +00:00
|
|
|
|
Additionally, the following options are only supported using Auto Unseal:
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
- `stored_shares` `(int: <required>)` – Specifies the number of shares that
|
|
|
|
|
should be encrypted by the HSM and stored for auto-unsealing. Currently must
|
|
|
|
|
be the same as `secret_shares`.
|
|
|
|
|
|
2018-03-20 15:45:56 +00:00
|
|
|
|
- `recovery_shares` `(int: <required>)` – Specifies the number of shares to
|
2017-03-15 06:40:33 +00:00
|
|
|
|
split the recovery key into.
|
|
|
|
|
|
2018-03-20 15:45:56 +00:00
|
|
|
|
- `recovery_threshold` `(int: <required>)` – Specifies the number of shares
|
2017-03-15 06:40:33 +00:00
|
|
|
|
required to reconstruct the recovery key. This must be less than or equal to
|
|
|
|
|
`recovery_shares`.
|
|
|
|
|
|
|
|
|
|
- `recovery_pgp_keys` `(array<string>: nil)` – Specifies an array of PGP public
|
|
|
|
|
keys used to encrypt the output recovery 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 `recovery_shares`.
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"secret_shares": 10,
|
|
|
|
|
"secret_threshold": 5
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
2020-05-21 17:18:17 +00:00
|
|
|
|
```shell-session
|
2017-03-15 06:40:33 +00:00
|
|
|
|
$ curl \
|
2022-02-25 14:52:24 +00:00
|
|
|
|
--request POST \
|
2017-06-07 14:02:58 +00:00
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/init
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
A JSON-encoded object including the (possibly encrypted, if `pgp_keys` was
|
|
|
|
|
provided) master keys, base 64 encoded master keys and initial root token:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"keys": ["one", "two", "three"],
|
|
|
|
|
"keys_base64": ["cR9No5cBC", "F3VLrkOo", "zIDSZNGv"],
|
|
|
|
|
"root_token": "foo"
|
|
|
|
|
}
|
|
|
|
|
```
|