Added documentation for listing roles in the Consul secret backend (#2619)

This commit is contained in:
Chad Greenburg 2017-04-20 06:44:25 -05:00 committed by Jeff Mitchell
parent 33d2f6fafe
commit 0716a3ef2b

View File

@ -145,6 +145,35 @@ $ curl \
}
```
## List Roles
This endpoint lists all existing roles in the backend.
| Method | Path | Produces |
| :------- | :--------------------------- | :--------------------- |
| `LIST` | `/consul/roles` | `200 application/json` |
### Sample Request
```
$ curl \
--header "X-Vault-Token: ..." \
--request LIST \
https://vault.rocks/v1/consul/roles
```
### Sample Response
```json
{
"data": {
"keys": [
"example-role"
]
}
}
```
## Delete Role
This endpoint deletes a Consul role with the given name. Even if the role does