indices.resolve_cluster.json

{
  "indices.resolve_cluster": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html",
      "description": "Resolves the specified index expressions to return information about each cluster. If no index expression is provided, this endpoint will return information about all the remote clusters that are configured on the local cluster."
    },
    "stability": "stable",
    "visibility": "public",
    "headers": {
      "accept": ["application/json"]
    },
    "url": {
      "paths": [
        {
          "path": "/_resolve/cluster",
          "methods": ["GET"]
        },
        {
          "path": "/_resolve/cluster/{name}",
          "methods": ["GET"],
          "parts": {
            "name": {
              "type": "list",
              "description": "A comma-separated list of cluster:index names or wildcard expressions"
            }
          }
        }
      ]
    },
    "params": {
      "ignore_unavailable": {
        "type": "boolean",
        "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression."
      },
      "ignore_throttled": {
        "type": "boolean",
        "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression."
      },
      "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). Only allowed when providing an index expression."
      },
      "expand_wildcards": {
        "type": "enum",
        "options": ["open", "closed", "hidden", "none", "all"],
        "default": "open",
        "description": "Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression."
      },
      "timeout": {
        "type": "time",
        "description": "The maximum time to wait for remote clusters to respond"
      }
    }
  }
}