search_shards.json

{
  "search_shards": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html",
      "description": "Returns information about the indices and shards that a search request would be executed against."
    },
    "stability": "stable",
    "visibility": "public",
    "headers": {
      "accept": ["application/json"]
    },
    "url": {
      "paths": [
        {
          "path": "/_search_shards",
          "methods": ["GET", "POST"]
        },
        {
          "path": "/{index}/_search_shards",
          "methods": ["GET", "POST"],
          "parts": {
            "index": {
              "type": "list",
              "description": "A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"
            }
          }
        }
      ]
    },
    "params": {
      "preference": {
        "type": "string",
        "description": "Specify the node or shard the operation should be performed on (default: random)"
      },
      "routing": {
        "type": "string",
        "description": "Specific routing value"
      },
      "local": {
        "type": "boolean",
        "description": "Return local information, do not retrieve the state from master node (default: false)"
      },
      "ignore_unavailable": {
        "type": "boolean",
        "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
      },
      "allow_no_indices": {
        "type": "boolean",
        "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
      },
      "expand_wildcards": {
        "type": "enum",
        "options": ["open", "closed", "hidden", "none", "all"],
        "default": "open",
        "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
      },
      "master_timeout": {
        "type": "time",
        "description": "Explicit operation timeout for connection to master node"
      }
    }
  }
}