This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.

2017-03-16 09:46:49 -07:00

1.2 KiB

Raw Blame History

layout	page_title	sidebar_current	description
http	/sys/capabilities-self - HTTP API	docs-http-system-capabilities-self	The `/sys/capabilities-self` endpoint is used to fetch the capabilities of client token on a given path.

`/sys/capabilities-self`

The /sys/capabilities-self endpoint is used to fetch the capabilities of a the supplied token.

Query Self Capabilities

This endpoint returns the capabilities of client token on the given path. The client token is the Vault token with which this API call is made.

Method	Path	Produces
`POST`	`/sys/capabilities-self`	`200 application/json`

Parameters

path (string: <required>) – Specifies the path on which the client token's capabilities will be checked.

Sample Payload

{
  "path": "secret/foo"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data payload.json \
    https://vault.rocks/v1/sys/capabilities-self

Sample Response

{
  "capabilities": ["read", "list"]
}

1.2 KiB Raw Blame History Unescape Escape

/sys/capabilities-self