Skip to content

Commit f1f9ed4

Browse files
committed
Update website docs to reflect fix in #5495
1 parent c34cc1e commit f1f9ed4

File tree

2 files changed

+8
-42
lines changed

2 files changed

+8
-42
lines changed

website/source/api/system/generate-root.html.md

+4-21
Original file line numberDiff line numberDiff line change
@@ -51,40 +51,23 @@ encode the final root token, it will never be returned.
5151
## Start Root Token Generation
5252

5353
This endpoint initializes a new root generation attempt. Only a single root
54-
generation attempt can take place at a time. One (and only one) of `otp` or
55-
`pgp_key` are required.
56-
57-
Note: `otp` can be empty, in which case an OTP of suitable length will be
58-
generated for you, which is recommended. Future versions of Vault will remove
59-
the need to set this parameter at all.
54+
generation attempt can take place at a time.
6055

6156
| Method | Path | Produces |
6257
| :------- | :--------------------------- | :--------------------- |
6358
| `PUT` | `/sys/generate-root/attempt` | `200 application/json` |
6459

6560
### Parameters
6661

67-
- `otp` `(string: <required-unless-pgp>)` – Set, but leave this value blank, to
68-
have Vault generate a suitable OTP and return it.
69-
70-
- `pgp_key` `(string: <required-unless-otp>)` – Specifies a base64-encoded PGP
71-
public key. The raw bytes of the token will be encrypted with this value
72-
before being returned to the final unseal key provider.
73-
74-
### Sample Payload
75-
76-
```json
77-
{
78-
"otp": ""
79-
}
80-
```
62+
- `pgp_key` `(string: <optional>)` – Specifies a base64-encoded PGP public key.
63+
The raw bytes of the token will be encrypted with this value before being
64+
returned to the final unseal key provider.
8165

8266
### Sample Request
8367

8468
```
8569
$ curl \
8670
--request PUT \
87-
--data @payload.json \
8871
http://127.0.0.1:8200/v1/sys/generate-root/attempt
8972
```
9073

website/source/api/system/replication-dr.html.md

+4-21
Original file line numberDiff line numberDiff line change
@@ -454,40 +454,23 @@ encode the final token, it will never be returned.
454454
## Start Token Generation
455455

456456
This endpoint initializes a new generation attempt. Only a single
457-
generation attempt can take place at a time. One (and only one) of `otp` or
458-
`pgp_key` are required.
459-
460-
Note: `otp` can be empty, in which case an OTP of suitable length will be
461-
generated for you, which is recommended. Future versions of Vault will remove
462-
the need to set this parameter at all.
457+
generation attempt can take place at a time.
463458

464459
| Method | Path | Produces |
465460
| :------- | :--------------------------- | :--------------------- |
466461
| `PUT` | `/sys/replication/dr/secondary/generate-operation-token/attempt` | `200 application/json` |
467462

468463
### Parameters
469464

470-
- `otp` `(string: <required-unless-pgp>)` – Set, but leave this value blank, to
471-
have Vault generate a suitable OTP and return it.
472-
473-
- `pgp_key` `(string: <required-unless-otp>)` – Specifies a base64-encoded PGP
474-
public key. The raw bytes of the token will be encrypted with this value
475-
before being returned to the final unseal key provider.
476-
477-
### Sample Payload
478-
479-
```json
480-
{
481-
"otp": ""
482-
}
483-
```
465+
- `pgp_key` `(string: <optional>)` – Specifies a base64-encoded PGP public key.
466+
The raw bytes of the token will be encrypted with this value before being
467+
returned to the final unseal key provider.
484468

485469
### Sample Request
486470

487471
```
488472
$ curl \
489473
--request PUT \
490-
--data @payload.json \
491474
http://127.0.0.1:8200/v1/sys/replication/dr/secondary/generate-operation-token/attempt
492475
```
493476

0 commit comments

Comments
 (0)