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

Endpoints for managing Nomad variables, which store encrypted key-value data.

HashiCorp Nomad Variables 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 Variables. 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 2 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 2 paths 2 schemas 1 DELETE2 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 Variables 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 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Variables 4

Endpoints for managing Nomad variables, which store encrypted key-value data.

GET
/vars
List variables
listVariables 4 params → 200401500
GET
/var/{variablePath}
Read a variable
readVariable 2 params → 200401404500
PUT
/var/{variablePath}
Create or update a variable
upsertVariable 2 params body → 200400401500
DELETE
/var/{variablePath}
Delete a variable
deleteVariable 2 params → 200401404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Variable (7 properties), VariableMetadata (6 properties). Each schema is shown below with its type and property counts.

Variable
object
A Nomad variable containing encrypted key-value data.
7 properties
VariableMetadata
object
Metadata about a Nomad variable without the item values.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nomad-variables-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