File tree 2 files changed +8
-42
lines changed
website/source/api/system
2 files changed +8
-42
lines changed Original file line number Diff line number Diff line change @@ -51,40 +51,23 @@ encode the final root token, it will never be returned.
51
51
## Start Root Token Generation
52
52
53
53
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.
60
55
61
56
| Method | Path | Produces |
62
57
| :------- | :--------------------------- | :--------------------- |
63
58
| ` PUT ` | ` /sys/generate-root/attempt ` | ` 200 application/json ` |
64
59
65
60
### Parameters
66
61
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.
81
65
82
66
### Sample Request
83
67
84
68
```
85
69
$ curl \
86
70
--request PUT \
87
- --data @payload.json \
88
71
http://127.0.0.1:8200/v1/sys/generate-root/attempt
89
72
```
90
73
Original file line number Diff line number Diff line change @@ -454,40 +454,23 @@ encode the final token, it will never be returned.
454
454
## Start Token Generation
455
455
456
456
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.
463
458
464
459
| Method | Path | Produces |
465
460
| :------- | :--------------------------- | :--------------------- |
466
461
| ` PUT ` | ` /sys/replication/dr/secondary/generate-operation-token/attempt ` | ` 200 application/json ` |
467
462
468
463
### Parameters
469
464
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.
484
468
485
469
### Sample Request
486
470
487
471
```
488
472
$ curl \
489
473
--request PUT \
490
- --data @payload.json \
491
474
http://127.0.0.1:8200/v1/sys/replication/dr/secondary/generate-operation-token/attempt
492
475
```
493
476
You can’t perform that action at this time.
0 commit comments