ACL Templated Policy HTTP API
The /acl/templated-policy
endpoints read,
preview and list ACL templated policies in Consul.
For more information on how to setup ACLs, please check the ACL tutorial.
Read a Templated Policy by Name
This endpoint reads an ACL policy with the given ID.
Method | Path | Produces |
---|---|---|
GET | /acl/templated-policy/name/:name | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.
Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
---|---|---|---|
NO | none | none | acl:read |
The corresponding CLI command is consul acl templated-policy read -name=<string>
.
Path Parameters
name
(string: <required>)
- Specifies the name of the ACL policy to read.
Sample Request
Sample Response
Preview a Templated Policy
This endpoint shows the resulting policy created from a templated policy. Useful to understand what templated variables are required/missing from your request.
Method | Path | Produces |
---|---|---|
POST | /acl/templated-policy/preview/:name | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.
Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
---|---|---|---|
NO | none | none | acl:read |
The corresponding CLI command is consul acl templated-policy preview
.
Path Parameters
name
(string: <required>)
- Specifies the name of the ACL templated policy to preview.
Query Parameters
ns
(string: "")
Enterprise - Specifies the namespace of the acl templated policy is previewed in. You can also specify the namespace through other methods.
JSON Request Body Schema
Name
(string: <optional>)
- If specified, it is used as to specify the name field on the templated policy variables.
Sample Payload
Sample Request
Sample Response
List Templated Policies
This endpoint lists all the ACL templated policies.
Method | Path | Produces |
---|---|---|
GET | /acl/templated-policies | application/json |
The table below shows this endpoint's support for blocking queries, consistency modes, agent caching, and required ACLs.
Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
---|---|---|---|
No | none | none | acl:read |
The corresponding CLI command is consul acl templated-policy list
.
Query Parameters
- NONE
Sample Request
Sample Response
Methods to Specify Namespace Enterprise
ACL templated policy endpoints support several methods for specifying the namespace of the ACL templated policy resources with the following order of precedence:
Namespace
field of the JSON request body - only applies to create and update endpointsns
query parameterX-Consul-Namespace
request header- Namespace is inherited from the namespace of the request's ACL token (if any)
- The
default
namespace