github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add return info for update and delete acl-token apis (#4584) 

* Update Token API returns the ID of the token updated.
 * Delete Token API returns a raw text which is true for successful deletions
pull/4542/head^2
Raja Nadar 2018-10-24 08:11:51 -07:00 committed by Matt Keeler
parent 4ea03e7db7
commit e7629564ef
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
website/source/api/acl.html.md
View File

@ -161,6 +161,14 @@ $ curl \
http://127.0.0.1:8500/v1/acl/update http://127.0.0.1:8500/v1/acl/update
``` ```
### Sample Response
```json
{
"ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
}
```
## Delete ACL Token ## Delete ACL Token
This endpoint deletes an ACL token with the given ID. This endpoint deletes an ACL token with the given ID.
@ -169,6 +177,8 @@ This endpoint deletes an ACL token with the given ID.
| ------ | ---------------------------- | -------------------------- | | ------ | ---------------------------- | -------------------------- |
| `PUT` | `/acl/destroy/:uuid` | `application/json` | | `PUT` | `/acl/destroy/:uuid` | `application/json` |
Even though the return type is application/json, the value is either true or false, indicating whether the delete succeeded.
The table below shows this endpoint's support for The table below shows this endpoint's support for
[blocking queries](/api/index.html#blocking-queries), [blocking queries](/api/index.html#blocking-queries),
[consistency modes](/api/index.html#consistency-modes), [consistency modes](/api/index.html#consistency-modes),
@ -192,6 +202,13 @@ $ curl \
http://127.0.0.1:8500/v1/acl/destroy/8f246b77-f3e1-ff88-5b48-8ec93abf3e05 http://127.0.0.1:8500/v1/acl/destroy/8f246b77-f3e1-ff88-5b48-8ec93abf3e05
``` ```
### Sample Response
```json
true
```
## Read ACL Token ## Read ACL Token
This endpoint reads an ACL token with the given ID. This endpoint reads an ACL token with the given ID.