2017-03-15 06:40:33 +00:00
|
|
|
|
---
|
2017-03-17 18:06:03 +00:00
|
|
|
|
layout: "api"
|
2017-03-15 06:40:33 +00:00
|
|
|
|
page_title: "/sys/capabilities - HTTP API"
|
|
|
|
|
|
sidebar_current: "docs-http-system-capabilities/"
|
|
|
|
|
|
description: |-
|
|
|
|
|
|
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token
|
|
|
|
|
|
on a given path.
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
# `/sys/capabilities`
|
|
|
|
|
|
|
|
|
|
|
|
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token on
|
|
|
|
|
|
a given path.
|
|
|
|
|
|
|
|
|
|
|
|
## Query Token Capabilities
|
|
|
|
|
|
|
|
|
|
|
|
This endpoint returns the list of capabilities for a provided token.
|
|
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
|
| :------- | :------------------- | :--------------------- |
|
|
|
|
|
|
| `POST` | `/sys/capabilities` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
|
|
- `path` `(string: <required>)` – Specifies the path against which to check the
|
|
|
|
|
|
token's capabilities.
|
|
|
|
|
|
|
|
|
|
|
|
- `token` `(string: <required>)` – Specifies the token for which to check
|
|
|
|
|
|
capabilities.
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"path": "secret/foo",
|
|
|
|
|
|
"token": "abcd1234"
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
$ curl \
|
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
|
--request POST \
|
|
|
|
|
|
--data @payload.json \
|
|
|
|
|
|
https://vault.rocks/v1/sys/capabilities
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
|
{
|
|
|
|
|
|
"capabilities": ["read", "list"]
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
