HashiCorp Nomad Allocations API
Endpoints for querying allocations. An allocation declares that a set of tasks in a job should be run on a particular node.
HashiCorp Nomad Allocations 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 Allocations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.
This API exposes 4 operations across 4 paths, and defines 10 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
HashiCorp Nomad Allocations 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 4
Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.
Endpoints for querying allocations. An allocation declares that a set of tasks in a job should be run on a particular node.
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Job (23 properties), Allocation (19 properties), AllocationListStub (16 properties), ServiceRegistration (12 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HashiCorp Nomad 12
Other APIs HashiCorp Nomad publishes across the network.