OpenSearch/rest-api-spec/api/indices.get_warmer.json

{
  "indices.get_warmer": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-warmers.html",
    "methods": ["GET"],
    "url": {
      "path": "/_warmer",
      "paths": [ "/_warmer", "/{index}/_warmer", "/{index}/_warmer/{name}", "/_warmer/{name}", "/{index}/{type}/_warmer/{name}"],
      "parts": {
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices"
        },
        "name": {
          "type" : "list",
          "description" : "The name of the warmer (supports wildcards); leave empty to get all warmers"
        },
        "type": {
          "type" : "list",
          "description" : "A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types"
        }
      },
      "params": {
        "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","none","all"],
            "default" : "open",
            "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
        },
        "local": {
            "type": "boolean",
            "description": "Return local information, do not retrieve the state from master node (default: false)"
        }
      }
    },
    "body": null
  }
}