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

System-level cluster operations.

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

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

3 operations 3 paths 0 schemas 3 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 System 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

System 3

System-level cluster operations.

GET
/status/leader
Read leader address
→ 200
GET
/status/peers
List server peers
→ 200
GET
/agent/health
Agent health
→ 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-nomad-system-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 Jobs API
HashiCorp Nomad Namespaces API
HashiCorp Nomad Nodes API