• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Nomad
  • Install
  • Intro
  • Tutorials
  • Documentation
  • API
  • Tools
  • Plugins
  • Sign up
Nomad Home

Documentation

Skip to main content
  • Documentation

    • Overview
    • acl
    • audit
    • autopilot
    • client
    • consul
    • plugin
    • sentinel
    • search
    • server
    • server_join
    • telemetry
    • tls
    • ui
    • vault

  • Schedulers

  • Nomad Ecosystem
  • Nomad Partnerships
  • Who Uses Nomad
  • FAQ

  • Resources

  • Tutorial Library
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Nomad
  3. Documentation
  4. Configuration
  5. search
  • Nomad
  • v1.3.x
  • v1.2.x
  • v1.1.x
  • v1.0.x
  • v0.12.x
  • v0.11.x

ยปsearch Block

Placementserver -> search

The search block specifies configuration for the search API provided by the Nomad servers.

server {
  search {
    fuzzy_enabled   = true
    limit_query     = 200
    limit_results   = 1000
    min_term_length = 5
  }
}

search Parameters

  • fuzzy_enabled (bool: true) - Specifies whether the fuzzy search API is enabled. If not enabled, requests to the fuzzy search API endpoint will return an error response.

  • limit_query (int: 20) - Specifies the maximum number of Nomad objects to search through per context type in the Nomad server before truncating results. Setting this parameter to a high value may degrade Nomad server performance.

  • limit_results (int: 100) - Specifies the maximum number of matching results to accumulate per context type in the API response before truncating results. Setting this parameter to a high value may cause excessively large API response sizes.

  • min_term_length (int: 2) - Specifies the minimum size of the search term allowed for matching with the fuzzy search API. Setting this value higher can prevent unnecessary load on the Nomad server from broad queries.

Edit this page on GitHub

On this page

  1. search Block
  2. search Parameters
Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)