a43e292424
* conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
3.3 KiB
layout, page_title, sidebar_title, sidebar_current, description
| layout | page_title | sidebar_title | sidebar_current | description |
|---|---|---|---|---|
| api | /sys/init - HTTP API | <tt>/sys/init</tt> | api-http-system-init | The `/sys/init` endpoint is used to initialize a new Vault. |
/sys/init
The /sys/init endpoint is used to initialize a new Vault.
Read Initialization Status
This endpoint returns the initialization status of Vault.
| Method | Path | Produces |
|---|---|---|
GET |
/sys/init |
200 application/json |
Sample Request
$ curl \
http://127.0.0.1:8200/v1/sys/init
Sample Response
{
"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 available when using Vault HSM.
| Method | Path | Produces |
|---|---|---|
PUT |
/sys/init |
200 application/json |
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 assecret_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 equalsecret_shares. If using Vault HSM with auto-unsealing, this value must be the same assecret_shares.
Additionally, the following options are only supported on Vault Pro/Enterprise:
-
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 assecret_shares. -
recovery_shares(int: <required>)– Specifies the number of shares to split the recovery key into. -
recovery_threshold(int: <required>)– Specifies the number of shares required to reconstruct the recovery key. This must be less than or equal torecovery_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 asrecovery_shares.
Sample Payload
{
"secret_shares": 10,
"secret_threshold": 5
}
Sample Request
$ curl \
--request PUT \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/init
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:
{
"keys": ["one", "two", "three"],
"keys_base64": ["cR9No5cBC", "F3VLrkOo", "zIDSZNGv"],
"root_token": "foo"
}