HashiCorp Nomad

HashiCorp Nomad is a flexible workload orchestrator that enables organizations to deploy and manage containers, non-containerized applications, and batch jobs across on-premises and cloud environments. It provides a single unified workflow for scheduling diverse workloads with high availability and multi-region federation.
1 APIs 0 Features
ContainersHashiCorpMulti-CloudOrchestrationSchedulingWorkloads
APIs

HashiCorp Nomad

HashiCorp Nomad is a flexible workload orchestrator that deploys and manages containers, legacy applications, microservices, and batch jobs. It supports Docker, Java, VMs, and e...
Collections

HashiCorp Nomad HTTP API

OPEN
Pricing Plans

Hashicorp Nomad Plans Pricing

3 plans
PLANS
Rate Limits

Hashicorp Nomad Rate Limits

5 limits
RATE LIMITS
FinOps

Hashicorp Nomad Finops

FINOPS
Resources

GitHubOrganization
Sources

opencollection: 1.0.0
info:
  name: HashiCorp Nomad HTTP API
  version: '1.8'
request:
  auth:
    type: apikey
    key: X-Nomad-Token
    value: '{{X-Nomad-Token}}'
    placement: header
items:
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: List jobs
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/jobs
      params:
      - name: namespace
        value: ''
        type: query
        description: Namespace to filter by.
      - name: filter
        value: ''
        type: query
        description: URL-encoded server-side filter expression.
    docs: Lists all known jobs in the system registered with Nomad.
  - info:
      name: Create or register job
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/jobs
    docs: Creates or registers a new job.
  - info:
      name: Parse HCL jobspec
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/jobs/parse
    docs: Converts HCL jobspec to JSON format.
  - info:
      name: Read job
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id
      params:
      - name: job_id
        value: ''
        type: path
    docs: Retrieves specification and status for a single job.
  - info:
      name: Update job
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/job/:job_id
      params:
      - name: job_id
        value: ''
        type: path
    docs: Updates an existing job.
  - info:
      name: Deregister job
      type: http
    http:
      method: DELETE
      url: http://127.0.0.1:4646/v1/job/:job_id
      params:
      - name: job_id
        value: ''
        type: path
    docs: Deregisters a job, and stops all allocations part of it.
  - info:
      name: List job versions
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/versions
      params:
      - name: job_id
        value: ''
        type: path
    docs: Reads information about all job versions.
  - info:
      name: Read job summary
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/summary
      params:
      - name: job_id
        value: ''
        type: path
    docs: Obtains summary information about a job.
  - info:
      name: Force evaluation
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/job/:job_id/evaluate
      params:
      - name: job_id
        value: ''
        type: path
    docs: Forces scheduler to run for the given job.
  - info:
      name: Plan job
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/job/:job_id/plan
      params:
      - name: job_id
        value: ''
        type: path
    docs: Executes a dry-run of the scheduler.
  - info:
      name: List job allocations
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/allocations
      params:
      - name: job_id
        value: ''
        type: path
    docs: Reads allocation information for a job.
  - info:
      name: List job deployments
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/deployments
      params:
      - name: job_id
        value: ''
        type: path
    docs: Lists a job's deployment history.
  - info:
      name: Read most recent deployment
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/deployment
      params:
      - name: job_id
        value: ''
        type: path
    docs: Retrieves the most recent deployment.
  - info:
      name: Read scale status
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/scale
      params:
      - name: job_id
        value: ''
        type: path
    docs: Reads scaling status information.
  - info:
      name: Scale task group
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/job/:job_id/scale
      params:
      - name: job_id
        value: ''
        type: path
    docs: Modifies task group counts.
  - info:
      name: List task actions
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/job/:job_id/actions
      params:
      - name: job_id
        value: ''
        type: path
    docs: Lists available task actions.
- info:
    name: Nodes
    type: folder
  items:
  - info:
      name: List nodes
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/nodes
      params:
      - name: filter
        value: ''
        type: query
        description: URL-encoded server-side filter expression.
    docs: Retrieves all registered nodes with optional filtering.
  - info:
      name: Read node
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/node/:node_id
      params:
      - name: node_id
        value: ''
        type: path
    docs: Queries the status of a client node.
  - info:
      name: List node allocations
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/node/:node_id/allocations
      params:
      - name: node_id
        value: ''
        type: path
    docs: Returns allocations scheduled on a specific node.
  - info:
      name: Create node evaluation
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/node/:node_id/evaluate
      params:
      - name: node_id
        value: ''
        type: path
    docs: Forces a scheduling logic run for the given node.
  - info:
      name: Toggle node drain
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/node/:node_id/drain
      params:
      - name: node_id
        value: ''
        type: path
    docs: Toggles the drain mode of the node.
  - info:
      name: Purge node
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/node/:node_id/purge
      params:
      - name: node_id
        value: ''
        type: path
    docs: Removes a node from the system.
  - info:
      name: Toggle node eligibility
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/node/:node_id/eligibility
      params:
      - name: node_id
        value: ''
        type: path
    docs: Changes scheduling eligibility status to eligible or ineligible.
- info:
    name: Allocations
    type: folder
  items:
  - info:
      name: List allocations
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/allocations
    docs: List allocations
  - info:
      name: Read allocation
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/allocation/:alloc_id
      params:
      - name: alloc_id
        value: ''
        type: path
    docs: Read allocation
- info:
    name: Deployments
    type: folder
  items:
  - info:
      name: List deployments
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/deployments
    docs: List deployments
  - info:
      name: Read deployment
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/deployment/:deployment_id
      params:
      - name: deployment_id
        value: ''
        type: path
    docs: Read deployment
- info:
    name: Evaluations
    type: folder
  items:
  - info:
      name: List evaluations
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/evaluations
    docs: List evaluations
  - info:
      name: Read evaluation
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/evaluation/:eval_id
      params:
      - name: eval_id
        value: ''
        type: path
    docs: Read evaluation
- info:
    name: Namespaces
    type: folder
  items:
  - info:
      name: List namespaces
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/namespaces
    docs: List namespaces
  - info:
      name: Read namespace
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/namespace/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Read namespace
  - info:
      name: Create or update namespace
      type: http
    http:
      method: POST
      url: http://127.0.0.1:4646/v1/namespace/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Create or update namespace
  - info:
      name: Delete namespace
      type: http
    http:
      method: DELETE
      url: http://127.0.0.1:4646/v1/namespace/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Delete namespace
- info:
    name: ACL
    type: folder
  items:
  - info:
      name: List ACL tokens
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/acl/tokens
    docs: List ACL tokens
  - info:
      name: List ACL policies
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/acl/policies
    docs: List ACL policies
- info:
    name: System
    type: folder
  items:
  - info:
      name: Read leader address
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/status/leader
    docs: Read leader address
  - info:
      name: List server peers
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/status/peers
    docs: List server peers
  - info:
      name: Agent health
      type: http
    http:
      method: GET
      url: http://127.0.0.1:4646/v1/agent/health
    docs: Agent health
bundled: true