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

{
  "indices.close": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-open-close.html",
    "methods": ["POST"],
    "url": {
      "path": "/{index}/_close",
      "paths": ["/{index}/_close"],
      "parts": {
        "index": {
          "type" : "string",
          "required" : true,
          "description" : "The name of the index"
        }
      },
      "params": {
        "timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout"
        },
        "master_timeout": {
          "type" : "time",
          "description" : "Specify timeout for connection to master"
        },
        "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."
        }
      }
    },
    "body": null
  }
}