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 Nomad ACL API

Endpoints for managing Access Control List policies, tokens, and authentication methods.

HashiCorp Nomad ACL API is one of 22 APIs that HashiCorp Nomad publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include ACL. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.

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

Requests are made against a single base URL, http://localhost:4646/v1.

9 operations 6 paths 4 schemas 2 DELETE5 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.9.0
Base URL
http://localhost:4646
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

HashiCorp Nomad ACL API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Nomad-Token (nomadToken). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • nomadToken — ACL token passed via the X-Nomad-Token request header.
  • bearerAuth — ACL token passed via the Authorization header with Bearer scheme.

Paths & Operations 9

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

ACL 9

Endpoints for managing Access Control List policies, tokens, and authentication methods.

GET
/acl/policies
List ACL policies
listACLPolicies 1 param → 200401500
GET
/acl/policy/{policyName}
Read an ACL policy
readACLPolicy 1 param → 200401404500
PUT
/acl/policy/{policyName}
Create or update an ACL policy
upsertACLPolicy 1 param body → 200400401500
DELETE
/acl/policy/{policyName}
Delete an ACL policy
deleteACLPolicy 1 param → 200401404500
GET
/acl/tokens
List ACL tokens
listACLTokens 1 param → 200401500
PUT
/acl/token
Create an ACL token
createACLToken body → 200400401500
GET
/acl/token/self
Read own ACL token
readSelfACLToken → 200401500
GET
/acl/token/{tokenAccessorID}
Read an ACL token
readACLToken 1 param → 200401404500
DELETE
/acl/token/{tokenAccessorID}
Delete an ACL token
deleteACLToken 1 param → 200401404500

Schemas 4

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

ACLTokenListStub
object
A stub representation of an ACL token.
9 properties
ACLPolicyListStub
object
A stub representation of an ACL policy.
4 properties
ACLPolicy
object
An ACL policy defining permissions for Nomad resources.
5 properties
ACLToken
object
An ACL token used for authentication and authorization.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nomad-acl-api-openapi.yml Raw ↑

Other APIs HashiCorp Nomad publishes across the network.

HashiCorp Nomad Go SDK
HashiCorp Nomad Python SDK
HashiCorp Nomad Java SDK
HashiCorp Nomad Agent API
HashiCorp Nomad Allocations API
HashiCorp Nomad Deployments API
HashiCorp Nomad Evaluations API
HashiCorp Nomad Jobs API
HashiCorp Nomad Namespaces API
HashiCorp Nomad Node Pools API
HashiCorp Nomad Nodes API
HashiCorp Nomad Operator API