2016-03-05 05:54:48 +00:00
|
|
|
---
|
|
|
|
layout: "http"
|
|
|
|
page_title: "HTTP API: /sys/capabilities"
|
|
|
|
sidebar_current: "docs-http-auth-capabilities"
|
|
|
|
description: |-
|
|
|
|
The `/sys/capabilities` endpoint is used to fetch the capabilities of a token on a given path.
|
|
|
|
---
|
|
|
|
|
|
|
|
# /sys/capabilities
|
|
|
|
|
|
|
|
## POST
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
<dt>Description</dt>
|
|
|
|
<dd>
|
|
|
|
Returns the capabilities of the token on the given path.
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>Method</dt>
|
|
|
|
<dd>POST</dd>
|
|
|
|
|
|
|
|
<dt>Parameters</dt>
|
|
|
|
<dd>
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
|
|
<span class="param">token</span>
|
|
|
|
<span class="param-flags">required</span>
|
2016-03-07 23:36:26 +00:00
|
|
|
Token for which capabilities are being queried.
|
2016-03-05 05:54:48 +00:00
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class="param">path</span>
|
|
|
|
<span class="param-flags">required</span>
|
2016-03-07 23:36:26 +00:00
|
|
|
Path on which the token's capabilities will be checked.
|
2016-03-05 05:54:48 +00:00
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>Returns</dt>
|
|
|
|
<dd>
|
|
|
|
|
|
|
|
```javascript
|
2016-03-07 23:36:26 +00:00
|
|
|
{
|
|
|
|
"capabilities": ["read", "list"]
|
|
|
|
}
|
2016-03-05 05:54:48 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</dl>
|