Body Required

• catalog string

  Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.

• columnar boolean

  If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.

• cursor string

  Cursor used to retrieve a set of paginated results. If you specify a cursor, the API only uses the columnar and time_zone request body parameters. It ignores other request body parameters.

• fetch_size number

  The maximum number of rows (or entries) to return in one response

• filter object

  Additional properties are allowed.

  External documentation
• query string

  SQL query to run.

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

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

• time_zone string
• field_multi_value_leniency boolean

  Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).

• runtime_mappings object
  Hide runtime_mappings attribute Show runtime_mappings attribute object

  • * object Additional properties

    Additional properties are allowed.

    Hide * attributes Show * attributes object

    • fields object

      For type composite

      Hide fields attribute Show fields attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attribute Show * attribute object

        • type string Required

          Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

    • fetch_fields array[object]

      For type lookup

      Hide fetch_fields attributes Show fetch_fields attributes object

      • field string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • format string
    • format string

      A custom format for date type runtime fields.

    • input_field string

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • target_field string

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • target_index string
    • script object

      Additional properties are allowed.

      Hide script attributes Show script attributes object

      • source string

        The script source.

      • id string
      • params object

        Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

        Hide params attribute Show params attribute object

        • * object Additional properties

          Additional properties are allowed.

      • lang string

        Any of:

        _types:ScriptLanguage string _types:ScriptLanguage string

        Values are painless, expression, mustache, or java.
      • options object
        Hide options attribute Show options attribute object

        • * string Additional properties
    • type string Required

      Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

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

• params object

  Values for parameters in the query.

  Hide params attribute Show params attribute object

  • * object Additional properties

    Additional properties are allowed.

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

• keep_on_completion boolean

  If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.

• index_using_frozen boolean

  If true, the search can run on frozen indices. Defaults to false.