Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HashiCorp Consul ACL API

Access Control List management

HashiCorp Consul ACL API is one of 14 APIs that HashiCorp Consul publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ACL. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

This API exposes 10 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.18.0.

Requests are made against 2 base URLs: http://localhost:8500/v1, https://{consul_host}:{port}/v1.

10 operations 6 paths 4 schemas 2 DELETE4 GET4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.18.0
Base URL
http://localhost:8500/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

HashiCorp Consul ACL API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Consul-Token (ConsulToken). By default, every request must be authenticated.

  • ConsulToken — ACL token for authentication

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

ACL 10

Access Control List management

PUT
/acl/token
Create a token
createACLToken body → 200
GET
/acl/token/{accessorID}
Read a token
getACLToken 1 param → 200
PUT
/acl/token/{accessorID}
Update a token
updateACLToken 1 param body → 200
DELETE
/acl/token/{accessorID}
Delete a token
deleteACLToken 1 param → 200
GET
/acl/tokens
List tokens
listACLTokens 3 params → 200
PUT
/acl/policy
Create a policy
createACLPolicy body → 200
GET
/acl/policies
List policies
listACLPolicies → 200
GET
/acl/policy/{policyID}
Read a policy
getACLPolicy 1 param → 200
PUT
/acl/policy/{policyID}
Update a policy
updateACLPolicy 1 param body → 200
DELETE
/acl/policy/{policyID}
Delete a policy
deleteACLPolicy 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ACLToken (10 properties), ACLPolicy (8 properties), ACLTokenRequest (7 properties), ACLPolicyRequest (4 properties). Each schema is shown below with its type and property counts.

ACLPolicy
object
8 properties
ACLPolicyRequest
object
4 properties 1 required
ACLToken
object
10 properties
ACLTokenRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

consul-acl-api-openapi.yml Raw ↑

Other APIs HashiCorp Consul publishes across the network.

HashiCorp Consul Agent API
HashiCorp Consul Catalog API
HashiCorp Consul Config Entries API
HashiCorp Consul Connect API
HashiCorp Consul Coordinates API
HashiCorp Consul Events API
HashiCorp Consul Health API
HashiCorp Consul KV Store API
HashiCorp Consul Operator API
HashiCorp Consul Sessions API
HashiCorp Consul Snapshot API
HashiCorp Consul Status API