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

Manage Nomad jobs and their lifecycle.

HashiCorp Nomad Jobs 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 Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 16 operations across 12 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.

16 operations 12 paths 0 schemas 1 DELETE9 GET6 POST

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 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.

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 1 DELETE, 9 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 16

Manage Nomad jobs and their lifecycle.

GET
/jobs
List jobs
2 params → 200
POST
/jobs
Create or register job
→ 200
POST
/jobs/parse
Parse HCL jobspec
→ 200
GET
/job/{job_id}
Read job
1 param → 200
POST
/job/{job_id}
Update job
1 param → 200
DELETE
/job/{job_id}
Deregister job
1 param → 200
GET
/job/{job_id}/versions
List job versions
1 param → 200
GET
/job/{job_id}/summary
Read job summary
1 param → 200
POST
/job/{job_id}/evaluate
Force evaluation
1 param → 200
POST
/job/{job_id}/plan
Plan job
1 param → 200
GET
/job/{job_id}/allocations
List job allocations
1 param → 200
GET
/job/{job_id}/deployments
List job deployments
1 param → 200
GET
/job/{job_id}/deployment
Read most recent deployment
1 param → 200
GET
/job/{job_id}/scale
Read scale status
1 param → 200
POST
/job/{job_id}/scale
Scale task group
1 param → 200
GET
/job/{job_id}/actions
List task actions
1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs HashiCorp Nomad publishes across the network.

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