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/policy - HTTP API"
|
|
|
|
|
sidebar_current: "docs-http-system-policy"
|
|
|
|
|
description: |-
|
|
|
|
|
The `/sys/policy` endpoint is used to manage ACL policies in Vault.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# `/sys/policy`
|
|
|
|
|
|
|
|
|
|
The `/sys/policy` endpoint is used to manage ACL policies in Vault.
|
|
|
|
|
|
|
|
|
|
## List Policies
|
|
|
|
|
|
|
|
|
|
This endpoint lists all configured policies.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `GET` | `/sys/policy` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/policy
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"policies": ["root", "deploy"]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Read Policy
|
|
|
|
|
|
2017-11-14 19:26:26 +00:00
|
|
|
|
This endpoint retrieve the policy body for the named policy.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `GET` | `/sys/policy/:name` | `200 application/json` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `name` `(string: <required>)` – Specifies the name of the policy to retrieve.
|
|
|
|
|
This is specified as part of the request URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/policy/my-policy
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Response
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
2017-11-14 19:26:26 +00:00
|
|
|
|
"policy": "path \"secret/foo\" {..."
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Create/Update Policy
|
|
|
|
|
|
|
|
|
|
This endpoint adds a new or updates an existing policy. Once a policy is
|
|
|
|
|
updated, it takes effect immediately to all associated users.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `PUT` | `/sys/policy/:name` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `name` `(string: <required>)` – Specifies the name of the policy to create.
|
|
|
|
|
This is specified as part of the request URL.
|
|
|
|
|
|
2017-11-14 19:26:26 +00:00
|
|
|
|
- `policy` `(string: <required>)` - Specifies the policy document.
|
2017-03-15 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
### Sample Payload
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
2017-11-14 19:26:26 +00:00
|
|
|
|
"policy": "path \"secret/foo\" {..."
|
2017-03-15 06:40:33 +00:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request PUT \
|
2017-06-07 14:02:58 +00:00
|
|
|
|
--data @payload.json \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/policy/my-policy
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Delete Policy
|
|
|
|
|
|
|
|
|
|
This endpoint deletes the policy with the given name. This will immediately
|
|
|
|
|
affect all users associated with this policy.
|
|
|
|
|
|
|
|
|
|
| Method | Path | Produces |
|
|
|
|
|
| :------- | :--------------------------- | :--------------------- |
|
|
|
|
|
| `DELETE` | `/sys/policy/:name` | `204 (empty body)` |
|
|
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
|
|
|
|
- `name` `(string: <required>)` – Specifies the name of the policy to delete.
|
|
|
|
|
This is specified as part of the request URL.
|
|
|
|
|
|
|
|
|
|
### Sample Request
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ curl \
|
|
|
|
|
--header "X-Vault-Token: ..." \
|
|
|
|
|
--request DELETE \
|
2018-03-23 15:41:51 +00:00
|
|
|
|
http://127.0.0.1:8200/v1/sys/policy/my-policy
|
2017-03-15 06:40:33 +00:00
|
|
|
|
```
|