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 Allocations API

Inspect task-to-node allocations.

HashiCorp Nomad Allocations API is one of 8 APIs that HashiCorp Nomad publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Allocations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.1.0, at version 1.8.

Requests are made against 2 base URLs: http://127.0.0.1:4646/v1, https://{nomad_host}:{port}/v1.

4 operations 4 paths 0 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.8
Servers
http://127.0.0.1:4646/v1
https://{nomad_host}:{port}/v1
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

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.

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.

Allocations 4

Inspect task-to-node allocations.

GET
/job/{job_id}/allocations
List job allocations
1 param → 200
GET
/node/{node_id}/allocations
List node allocations
1 param → 200
GET
/allocations
List allocations
→ 200
GET
/allocation/{alloc_id}
Read allocation
1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-nomad-allocations-api-openapi.yml Raw ↑

Other APIs HashiCorp Nomad publishes across the network.

HashiCorp Nomad ACL API
HashiCorp Nomad Deployments API
HashiCorp Nomad Evaluations API
HashiCorp Nomad Jobs API
HashiCorp Nomad Namespaces API
HashiCorp Nomad Nodes API
HashiCorp Nomad System API