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.

• all_shards boolean

  If true, the validation is executed on all shards instead of one random shard per index.

• analyzer string

  Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

• analyze_wildcard boolean

  If true, wildcard and prefix queries are analyzed.

• default_operator string

  The default operator for query string query: AND or OR.

  Values are and, AND, or, or OR.

• df string

  Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.

• 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.

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

• explain boolean

  If true, the response returns detailed information if an error has occurred.

• ignore_unavailable boolean

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

• lenient boolean

  If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

• rewrite boolean

  If true, returns a more detailed explanation showing the actual Lucene query that will be executed.

• q string

  Query in the Lucene query string syntax.

Responses

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

  • explanations array[object]
    Hide explanations attributes Show explanations attributes object

    • error string
    • explanation string
    • index string Required
    • valid boolean Required
  • _shards object
    Hide _shards attributes Show _shards attributes object

    • failed number Required
    • successful number Required
    • total number Required
    • failures array[object]
      Hide failures attributes Show failures attributes object

      • index string
      • node string
      • reason object Required

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide reason attributes Show reason attributes object

        • type string Required

          The type of error

        • reason string | null

          A human-readable explanation of the error, in English.

          One of:

          string-1 string string-2 string | null
        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_cause array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • suppressed array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • shard number Required
      • status string
    • skipped number
  • valid boolean Required
  • error string