Docs: update Tidy API (#5374)

- Add a sample response to /auth/token/tidy API docs
- Document /auth/approle/tidy/secret-id API docs
This commit is contained in:
Brian Shumate 2018-09-20 13:25:33 -04:00 committed by Chris Hoffman
parent f9d85c3d68
commit abdf729924
2 changed files with 54 additions and 0 deletions

View File

@ -640,3 +640,40 @@ to be able to delegate specific endpoints using Vault's ACL system.
| `GET/POST/DELETE` | `/auth/approle/role/:role_name/period` | `200/204` |
Refer to `/auth/approle/role/:role_name` endpoint.
## Tidy Tokens
Performs some maintenance tasks to clean up invalid entries that may remain
in the token store. Generally, running this is not needed unless upgrade
notes or support personnel suggest it. This may perform a lot of I/O to the
storage method so should be used sparingly.
| Method | Path | Produces |
| :------- | :------------------------------ | :--------------------- |
| `POST` | `/auth/approle/tidy/secret-id` | `204 (empty body)` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
http://127.0.0.1:8200/v1/auth/approle/tidy/secret-id
```
### Sample Response
```json
{
"request_id": "b20b56e3-4699-5b19-cc6b-e74f7b787bbf",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": [
"Tidy operation successfully started. Any information from the operation will be printed to Vault's server logs."
],
"auth": null
}
```

View File

@ -736,3 +736,20 @@ $ curl \
--request POST \
http://127.0.0.1:8200/v1/auth/token/tidy
```
### Sample Response
```json
{
"request_id": "84437c7f-36a1-6c1d-381d-14ec99217e94",
"lease_id": "",
"renewable": false,
"lease_duration": 0,
"data": null,
"wrap_info": null,
"warnings": [
"Tidy operation successfully started. Any information from the operation will be printed to Vault's server logs."
],
"auth": null
}
```