Skip to content

Commit

Permalink
Update website docs to reflect fix in #5495
Browse files Browse the repository at this point in the history
  • Loading branch information
jefferai committed Oct 10, 2018
1 parent c34cc1e commit f1f9ed4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 42 deletions.
25 changes: 4 additions & 21 deletions website/source/api/system/generate-root.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,40 +51,23 @@ encode the final root token, it will never be returned.
## Start Root Token Generation

This endpoint initializes a new root generation attempt. Only a single root
generation attempt can take place at a time. One (and only one) of `otp` or
`pgp_key` are required.

Note: `otp` can be empty, in which case an OTP of suitable length will be
generated for you, which is recommended. Future versions of Vault will remove
the need to set this parameter at all.
generation attempt can take place at a time.

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

### Parameters

- `otp` `(string: <required-unless-pgp>)` – Set, but leave this value blank, to
have Vault generate a suitable OTP and return it.

- `pgp_key` `(string: <required-unless-otp>)` – Specifies a base64-encoded PGP
public key. The raw bytes of the token will be encrypted with this value
before being returned to the final unseal key provider.

### Sample Payload

```json
{
"otp": ""
}
```
- `pgp_key` `(string: <optional>)` – Specifies a base64-encoded PGP public key.
The raw bytes of the token will be encrypted with this value before being
returned to the final unseal key provider.

### Sample Request

```
$ curl \
--request PUT \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/generate-root/attempt
```

Expand Down
25 changes: 4 additions & 21 deletions website/source/api/system/replication-dr.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -454,40 +454,23 @@ encode the final token, it will never be returned.
## Start Token Generation

This endpoint initializes a new generation attempt. Only a single
generation attempt can take place at a time. One (and only one) of `otp` or
`pgp_key` are required.

Note: `otp` can be empty, in which case an OTP of suitable length will be
generated for you, which is recommended. Future versions of Vault will remove
the need to set this parameter at all.
generation attempt can take place at a time.

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

### Parameters

- `otp` `(string: <required-unless-pgp>)` – Set, but leave this value blank, to
have Vault generate a suitable OTP and return it.

- `pgp_key` `(string: <required-unless-otp>)` – Specifies a base64-encoded PGP
public key. The raw bytes of the token will be encrypted with this value
before being returned to the final unseal key provider.

### Sample Payload

```json
{
"otp": ""
}
```
- `pgp_key` `(string: <optional>)` – Specifies a base64-encoded PGP public key.
The raw bytes of the token will be encrypted with this value before being
returned to the final unseal key provider.

### Sample Request

```
$ curl \
--request PUT \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/replication/dr/secondary/generate-operation-token/attempt
```

Expand Down

0 comments on commit f1f9ed4

Please sign in to comment.