/sys/policy
The /sys/policy
endpoint is used to manage ACL policies in Vault.
List policies
Restricted endpoint
The API path can only be called from the root or administrative namespace.This endpoint lists all configured policies.
Method | Path |
---|---|
GET | /sys/policy |
Sample request
Sample response
Read policy
Restricted endpoint
The API path can only be called from the root or administrative namespace.This endpoint retrieve the policy body for the named policy.
Method | Path |
---|---|
GET | /sys/policy/:name |
Parameters
name
(string: <required>)
– Specifies the name of the policy to retrieve. This is specified as part of the request URL.
Sample request
Sample response
Create/Update policy
Restricted endpoint
The API path can only be called from the root or administrative namespace.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 |
---|---|
POST | /sys/policy/:name |
Parameters
name
(string: <required>)
– Specifies the name of the policy to create. This is specified as part of the request URL.policy
(string: <required>)
-Â Specifies the policy document.
Sample payload
Sample request
Delete policy
Restricted endpoint
The API path can only be called from the root or administrative namespace.This endpoint deletes the policy with the given name. This will immediately affect all users associated with this policy.
Method | Path |
---|---|
DELETE | /sys/policy/:name |
Parameters
name
(string: <required>)
– Specifies the name of the policy to delete. This is specified as part of the request URL.
Sample request