Path parameters

• index string | array[string] Required

  Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

• name string | array[string] Required

  Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Query parameters

• allow_no_indices boolean

  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

• expand_wildcards string | array[string]

  Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

  Values are all, open, closed, hidden, or none.

• ignore_unavailable boolean

  If false, the request returns an error if it targets a missing or closed index.

• master_timeout string

  Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • * object Additional properties
    Hide * attribute Show * attribute object

    • aliases object Required
      Hide aliases attribute Show aliases attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • filter object

          An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          External documentation
          Hide filter attributes Show filter attributes object

          • bool object
          • boosting object
          • common object Deprecated
          • combined_fields object
          • constant_score object
          • dis_max object
          • distance_feature
          • exists object
          • function_score object
          • fuzzy object

            Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

            External documentation
          • geo_bounding_box object
          • geo_distance object
          • geo_grid object

            Matches geo_point and geo_shape values that intersect a grid cell from a GeoGrid aggregation.

          • geo_polygon object
          • geo_shape object
          • has_child object
          • has_parent object
          • ids object
          • intervals object

            Returns documents based on the order and proximity of matching terms.

            External documentation
          • knn object
          • match object

            Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

            External documentation
          • match_all object
          • match_bool_prefix object

            Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

            External documentation
          • match_none object
          • match_phrase object

            Analyzes the text and creates a phrase query out of the analyzed text.

            External documentation
          • match_phrase_prefix object

            Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

            External documentation
          • more_like_this object
          • multi_match object
          • nested object
          • parent_id object
          • percolate object
          • pinned
          • prefix object

            Returns documents that contain a specific prefix in a provided field.

            External documentation
          • query_string object
          • range object

            Returns documents that contain terms within a provided range.

            External documentation
          • rank_feature object
          • regexp object

            Returns documents that contain terms matching a regular expression.

            External documentation
          • rule object
          • script object
          • script_score object
          • semantic object
          • shape object
          • simple_query_string object
          • span_containing object
          • span_field_masking object
          • span_first object
          • span_multi object
          • span_near object
          • span_not object
          • span_or object
          • span_term object

            Matches spans containing a term.

            External documentation
          • span_within object
          • sparse_vector
          • term object

            Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

            External documentation
          • terms object
          • terms_set object

            Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

            External documentation
          • text_expansion object Deprecated Generally available; Added in 8.8.0

            Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

            External documentation
          • weighted_tokens object Deprecated Generally available; Added in 8.13.0

            Supports returning text_expansion query results by sending in precomputed tokens with the query.

            External documentation
          • wildcard object

            Returns documents that contain terms matching a wildcard pattern.

            External documentation
          • wrapper object
          • type object
        • index_routing string

          Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.

        • is_write_index boolean

          If true, the index is the write index for the alias.

        • routing string

          Value used to route indexing and search operations to a specific shard.

        • search_routing string

          Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.

        • is_hidden boolean Generally available; Added in 7.16.0

          If true, the alias is hidden. All indices for the alias must have the same is_hidden value.