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

{
  "indices.clear_cache": {
    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html",
    "methods": ["POST", "GET"],
    "url": {
      "path": "/_cache/clear",
      "paths": ["/_cache/clear", "/{index}/_cache/clear"],
      "parts": {
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index name to limit the operation"
        }
      },
      "params": {
        "field_data": {
          "type" : "boolean",
          "description" : "Clear field data"
        },
        "fielddata": {
          "type" : "boolean",
          "description" : "Clear field data"
        },
        "fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields to clear when using the `field_data` parameter (default: all)"
        },
        "filter": {
          "type" : "boolean",
          "description" : "Clear filter caches"
        },
        "filter_cache": {
          "type" : "boolean",
          "description" : "Clear filter caches"
        },
        "filter_keys": {
          "type" : "boolean",
          "description" : "A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)"
        },
        "id": {
          "type" : "boolean",
          "description" : "Clear ID caches for parent/child"
        },
        "id_cache": {
          "type" : "boolean",
          "description" : "Clear ID caches for parent/child"
        },
        "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."
        },
        "index": {
          "type" : "list",
          "description" : "A comma-separated list of index name to limit the operation"
        },
        "recycler": {
          "type" : "boolean",
          "description" : "Clear the recycler cache"
        },
        "query_cache": {
          "type" : "boolean",
          "description" : "Clear query cache"
        }
      }
    },
    "body": null
  }
}