HashiCorp Nomad Deployments API
Endpoints for querying and managing deployments. Deployments track the rolling update of allocations between two versions of a job.
HashiCorp Nomad Deployments 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 Deployments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.
This API exposes 6 operations across 6 paths, and defines 3 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 Deployments 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 6
Across 6 paths, the API surfaces 6 operations — 3 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Endpoints for querying and managing deployments. Deployments track the rolling update of allocations between two versions of a job.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are AllocationListStub (16 properties), Deployment (12 properties), DeploymentUpdateResponse (3 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.