HashiCorp Nomad Jobs API
Endpoints for listing, creating, reading, updating, and deleting jobs. Jobs are the primary unit of work in Nomad.
HashiCorp Nomad Jobs 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 Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.
This API exposes 16 operations across 14 paths, and defines 14 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 Jobs 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 16
Across 14 paths, the API surfaces 16 operations — 1 DELETE, 8 GET, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
Endpoints for listing, creating, reading, updating, and deleting jobs. Jobs are the primary unit of work in Nomad.
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Job (23 properties), Evaluation (20 properties), AllocationListStub (16 properties), JobListStub (15 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.