Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). To search all data streams or indices, 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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

• analyzer string

  Analyzer to use for the query string.

• analyze_wildcard boolean

  If true, wildcard and prefix queries are analyzed.

• conflicts string

  What to do if update by query hits version conflicts: abort or proceed.

  Values are abort or proceed.

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

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

• from number

  Starting offset (default: 0)

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

• max_docs number

  Maximum number of documents to process. Defaults to all documents.

• pipeline string

  ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.

• preference string

  Specifies the node or shard the operation should be performed on. Random by default.

• q string

  Query in the Lucene query string syntax.

• refresh boolean

  If true, Elasticsearch refreshes affected shards to make the operation visible to search.

• request_cache boolean

  If true, the request cache is used for this request.

• requests_per_second number

  The throttle for this request in sub-requests per second.

• routing string

  Custom value used to route operations to a specific shard.

• scroll string

  Period to retain the search context for scrolling.

• scroll_size number

  Size of the scroll request that powers the operation.

• search_timeout string

  Explicit timeout for each search request.

• search_type string

  The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch.

  Values are query_then_fetch or dfs_query_then_fetch.

• slices number | string

  The number of slices this task should be divided into.

• sort array[string]

  A comma-separated list of : pairs.

• stats array[string]

  Specific tag of the request for logging and statistical purposes.

• terminate_after number

  Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

• timeout string

  Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.

• version boolean

  If true, returns the document version as part of a hit.

• version_type boolean

  Should the document increment the version number (internal) on hit or not (reindex)

• wait_for_active_shards number | string

  The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

• wait_for_completion boolean

  If true, the request blocks until the operation is complete.

Responses

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

  • batches number
  • failures array[object]
    Hide failures attributes Show failures attributes object

    • cause object Required

      Additional properties are allowed.

      Hide cause attributes Show cause attributes object

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in english

      • stack_trace string

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

      • caused_by object

        Additional properties are allowed.

      • root_cause array[object]

        Additional properties are allowed.

      • suppressed array[object]

        Additional properties are allowed.

    • id string Required
    • index string Required
    • status number Required
    • type string Required
  • noops number
  • deleted number
  • requests_per_second number
  • retries object

    Additional properties are allowed.

    Hide retries attributes Show retries attributes object

    • bulk number Required
    • search number Required

  • task string | number

    One of:

    _types:TaskId string _types:TaskId number
  • timed_out boolean
  • took number

    Time unit for milliseconds

  • total number
  • updated number
  • version_conflicts number
  • throttled string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • throttled_millis number

    Time unit for milliseconds

  • throttled_until string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • throttled_until_millis number

    Time unit for milliseconds