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

Endpoints for cluster-level operations such as Raft peer management and autopilot configuration.

HashiCorp Nomad Operator 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 Operator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 1 JSON Schema.

This API exposes 5 operations across 4 paths. 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.

5 operations 4 paths 0 schemas 1 DELETE3 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.9.0
Base URL
http://localhost:4646
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

HashiCorp Nomad Operator 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 5

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

Operator 5

Endpoints for cluster-level operations such as Raft peer management and autopilot configuration.

GET
/operator/raft/configuration
Read Raft configuration
readRaftConfiguration → 200401500
DELETE
/operator/raft/peer
Remove a Raft peer
removeRaftPeer 2 params → 200401500
GET
/operator/autopilot/configuration
Read autopilot configuration
readAutopilotConfiguration → 200401500
PUT
/operator/autopilot/configuration
Update autopilot configuration
updateAutopilotConfiguration body → 200401500
GET
/operator/autopilot/health
Read autopilot health
readAutopilotHealth → 200401500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nomad-operator-api-openapi.yml Raw ↑

Other APIs HashiCorp Nomad publishes across the network.

HashiCorp Nomad Go SDK
HashiCorp Nomad Python SDK
HashiCorp Nomad Java SDK
HashiCorp Nomad ACL API
HashiCorp Nomad Agent API
HashiCorp Nomad Allocations API
HashiCorp Nomad Deployments API
HashiCorp Nomad Evaluations API
HashiCorp Nomad Jobs API
HashiCorp Nomad Namespaces API
HashiCorp Nomad Node Pools API
HashiCorp Nomad Nodes API