ACL Role HTTP API
1.5.0+: The role APIs are available in Consul versions 1.5.0 and newer.
The /acl/role
endpoints create, read,
update, list and delete ACL roles in Consul.
For more information on how to setup ACLs, please check the ACL tutorial.
Create a Role
This endpoint creates a new ACL role.
Method | Path | Produces |
---|---|---|
PUT | /acl/role | 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:write |
Parameters
Name
(string: <required>)
- Specifies a name for the ACL role. The name can contain alphanumeric characters, dashes-
, and underscores_
. This name must be unique.Description
(string: "")
- Free form human readable description of the role.Policies
(array<PolicyLink>)
- The list of policies that should be applied to the role. A PolicyLink is an object with an "ID" and/or "Name" field to specify a policy. With the PolicyLink, roles can be linked to policies either by the policy name or by the policy ID. When policies are linked by name they will be internally resolved to the policy ID. With linking roles internally by IDs, Consul enables policy renaming without breaking tokens.ServiceIdentities
(array<ServiceIdentity>)
- The list of service identities that should be applied to the role. Added in Consul 1.5.0.ServiceName
(string: <required>)
- The name of the service. The name must be no longer than 256 characters, must start and end with a lowercase alphanumeric character, and can only contain lowercase alphanumeric characters as well as-
and_
.Datacenters
(array<string>)
- Specifies the datacenters the effective policy is valid within. When no datacenters are provided the effective policy is valid in all datacenters including those which do not yet exist but may in the future.
NodeIdentities
(array<NodeIdentity>)
- The list of node identities that should be applied to the role. Added in Consul 1.8.1.NodeName
(string: <required>)
- The name of the node. The name must be no longer than 256 characters, must start and end with a lowercase alphanumeric character, and can only contain lowercase alphanumeric characters as well as-
and_
.Datacenter
(string: <required>)
- Specifies the nodes datacenter. This will result in effective policy only being valid in that datacenter.
Namespace
(string: "")
Enterprise - Specifies the namespace to create the role. If not provided in the JSON body, the value of thens
URL query parameter or in theX-Consul-Namespace
header will be used. If not provided, the namespace will be inherited from the request's ACL token or will default to thedefault
namespace. Added in Consul 1.7.0.
Sample Payload
Sample Request
Sample Response
Read a Role
This endpoint reads an ACL role with the given ID. If no role exists with the given ID, a 404 is returned instead of a 200 response.
Method | Path | Produces |
---|---|---|
GET | /acl/role/:id | 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 |
---|---|---|---|
YES | all | none | acl:read |
Parameters
id
(string: <required>)
- Specifies the UUID of the ACL role to read. This is required and is specified as part of the URL path.ns
(string: "")
Enterprise - Specifies the namespace to lookup the role. This value can be specified as thens
URL query parameter or theX-Consul-Namespace
header. If not provided by either, the namespace will be inherited from the request's ACL token or will default to thedefault
namespace. Added in Consul 1.7.0.
Sample Request
Sample Response
Read a Role by Name
This endpoint reads an ACL role with the given name. If no role exists with the given name, a 404 is returned instead of a 200 response.
Method | Path | Produces |
---|---|---|
GET | /acl/role/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 |
---|---|---|---|
YES | all | none | acl:read |
Parameters
name
(string: <required>)
- Specifies the Name of the ACL role to read. This is required and is specified as part of the URL path.ns
(string: "")
Enterprise - Specifies the namespace to lookup the role. This value can be specified as thens
URL query parameter or theX-Consul-Namespace
header. If not provided by either, the namespace will be inherited from the request's ACL token or will default to thedefault
namespace. Added in Consul 1.7.0.
Sample Request
Sample Response
Update a Role
This endpoint updates an existing ACL role.
Method | Path | Produces |
---|---|---|
PUT | /acl/role/:id | 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:write |
Parameters
ID
(string: <required>)
- Specifies the ID of the role to update. This is required in the URL path but may also be specified in the JSON body. If specified in both places then they must match exactly.Name
(string: <required>)
- Specifies a name for the ACL role. The name can only contain alphanumeric characters as well as-
and_
and must be unique.Description
(string: "")
- Free form human readable description of the role.Policies
(array<PolicyLink>)
- The list of policies that should be applied to the role. A PolicyLink is an object with an "ID" and/or "Name" field to specify a policy. With the PolicyLink, roles can be linked to policies either by the policy name or by the policy ID. When policies are linked by name they will be internally resolved to the policy ID. With linking roles internally by IDs, Consul enables policy renaming without breaking tokens.ServiceIdentities
(array<ServiceIdentity>)
- The list of service identities that should be applied to the role. Added in Consul 1.5.0.NodeIdentities
(array<NodeIdentity>)
- The list of node identities that should be applied to the role. Added in Consul 1.8.1.Namespace
(string: "")
Enterprise - Specifies the namespace of the role to update. If not provided in the JSON body, the value of thens
URL query parameter or in theX-Consul-Namespace
header will be used. If not provided, the namespace will be inherited from the request's ACL token or will default to thedefault
namespace. Added in Consul 1.7.0.
Sample Payload
Sample Request
Sample Response
Delete a Role
This endpoint deletes an ACL role.
Method | Path | Produces |
---|---|---|
DELETE | /acl/role/:id | application/json |
Even though the return type is application/json, the value is either true or false indicating whether the delete succeeded.
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:write |
Parameters
id
(string: <required>)
- Specifies the UUID of the ACL role to delete. This is required and is specified as part of the URL path.ns
(string: "")
Enterprise - Specifies the namespace of the role to delete. This value can be specified as thens
URL query parameter or theX-Consul-Namespace
header. If not provided by either, the namespace will be inherited from the request's ACL token or will default to thedefault
namespace. Added in Consul 1.7.0.
Sample Request
Sample Response
List Roles
This endpoint lists all the ACL roles.
Method | Path | Produces |
---|---|---|
GET | /acl/roles | 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 |
---|---|---|---|
YES | all | none | acl:read |
Parameters
policy
(string: "")
- Filters the role list to those roles that are linked with the specific policy ID.
Parameters
ns
(string: "")
Enterprise - Specifies the namespace to list the roles for. This value can be specified as thens
URL query parameter or theX-Consul-Namespace
header. If not provided by either, the namespace will be inherited from the request's ACL token or will default to thedefault
namespace. The namespace may be specified as '*' and then results will be returned for all namespaces. Added in Consul 1.7.0.
Sample Request
Sample Response