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

Endpoints for querying evaluations. Evaluations are the mechanism by which Nomad makes scheduling decisions.

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

This API exposes 4 operations across 4 paths, and defines 2 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.

4 operations 4 paths 2 schemas 4 GET

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 Evaluations 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 4

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

Evaluations 4

Endpoints for querying evaluations. Evaluations are the mechanism by which Nomad makes scheduling decisions.

GET
/evaluations
List evaluations
listEvaluations 7 params → 200401500
GET
/evaluations/count
Count evaluations
countEvaluations 1 param → 200401500
GET
/evaluation/{evalID}
Read an evaluation
readEvaluation 1 param → 200401404500
GET
/evaluation/{evalID}/allocations
List allocations for an evaluation
listEvaluationAllocations 1 param → 200401404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Evaluation (20 properties), AllocationListStub (16 properties). Each schema is shown below with its type and property counts.

AllocationListStub
object
A stub representation of an allocation returned in list operations.
16 properties
Evaluation
object
An evaluation represents a scheduling decision made by Nomad.
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nomad-evaluations-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 Jobs API
HashiCorp Nomad Namespaces API
HashiCorp Nomad Node Pools API
HashiCorp Nomad Nodes API
HashiCorp Nomad Operator API