Path parameters

• datafeed_id string Required

  A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

Query parameters

• allow_no_indices boolean

  If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the _all string or when no indices are 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.

• ignore_throttled boolean Deprecated

  If true, concrete, expanded, or aliased indices are ignored when frozen.

• ignore_unavailable boolean

  If true, unavailable indices (missing or closed) are ignored.

Responses

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

  • aggregations object
  • authorization object

    Additional properties are allowed.

    Hide authorization attributes Show authorization attributes object

    • api_key object

      Additional properties are allowed.

      Hide api_key attributes Show api_key attributes object

      • id string Required

        The identifier for the API key.

      • name string Required

        The name of the API key.

    • roles array[string]

      If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.

    • service_account string

      If a service account was used for the most recent update to the datafeed, the account name is listed in the response.

  • chunking_config object Required

    Additional properties are allowed.

    Hide chunking_config attributes Show chunking_config attributes object

    • mode string Required

      Values are auto, manual, or off.

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

  • delayed_data_check_config object

    Additional properties are allowed.

    Hide delayed_data_check_config attributes Show delayed_data_check_config attributes object

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

    • enabled boolean Required

      Specifies whether the datafeed periodically checks for delayed data.

  • datafeed_id string Required
  • frequency 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.

  • indices array[string] Required
  • job_id string Required
  • indices_options object

    Additional properties are allowed.

    Hide indices_options attributes Show indices_options attributes object

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

    • expand_wildcards string | array[string]
    • ignore_unavailable boolean

      If true, missing or closed indices are not included in the response.

    • ignore_throttled boolean

      If true, concrete, expanded or aliased indices are ignored when frozen.

  • max_empty_searches number
  • query object Required

    Additional properties are allowed.

    External documentation
  • query_delay string Required

    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.

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

  • script_fields object
    Hide script_fields attribute Show script_fields attribute object

    • * object Additional properties

      Additional properties are allowed.

      Hide * attributes Show * attributes object

      • script object Required

        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
      • ignore_failure boolean
  • scroll_size number Required