Path parameters

• datafeed_idstring | array[string] Required

  Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

Query parameters

• allow_no_matchboolean

  Specifies what to do when the request:

  1. Contains wildcard expressions and there are no datafeeds that match.
  2. Contains the _all string or no identifiers and there are no matches.
  3. Contains wildcard expressions and there are only partial matches.

  The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

• exclude_generatedboolean

  Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

Responses

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

  • countnumber Required
  • datafeedsarray[object] Required
    Hide datafeeds attributes Show datafeeds attributes object

    • aggregationsobject
    • authorizationobject
      Hide authorization attributes Show authorization attributes object

      • api_keyobject
        Hide api_key attributes Show api_key attributes object

        • idstring Required

          The identifier for the API key.

        • namestring Required

          The name of the API key.

      • rolesarray[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_accountstring

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

    • chunking_configobject
      Hide chunking_config attributes Show chunking_config attributes object

      • modestring Required

        Values are auto, manual, or off.

      • time_spanstring

        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.

    • datafeed_idstring Required
    • frequencystring

      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.

    • indicesarray[string] Required
    • indexesarray[string]
    • job_idstring Required
    • max_empty_searchesnumber
    • query_delaystring

      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.

    • script_fieldsobject
      Hide script_fields attribute Show script_fields attribute object

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

        • scriptobject Required
          Hide script attributes Show script attributes object

          • sourcestring

            The script source.

          • idstring
          • paramsobject

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

          • lang
          • optionsobject
        • ignore_failureboolean
    • scroll_sizenumber
    • delayed_data_check_configobject Required
      Hide delayed_data_check_config attributes Show delayed_data_check_config attributes object

      • check_windowstring

        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.

      • enabledboolean Required

        Specifies whether the datafeed periodically checks for delayed data.

    • runtime_mappingsobject
      Hide runtime_mappings attribute Show runtime_mappings attribute object

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

        • fieldsobject

          For type composite

          Hide fields attribute Show fields attribute object

          • *object Additional properties
        • fetch_fieldsarray[object]

          For type lookup
        • formatstring

          A custom format for date type runtime fields.

        • input_fieldstring

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

        • target_fieldstring

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

        • target_indexstring
        • scriptobject
          Hide script attributes Show script attributes object

          • sourcestring

            The script source.

          • idstring
          • paramsobject

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

          • lang
          • optionsobject
        • typestring Required

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

    • indices_optionsobject
      Hide indices_options attributes Show indices_options attributes object

      • allow_no_indicesboolean

        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_wildcardsstring | array[string]
      • ignore_unavailableboolean

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

      • ignore_throttledboolean

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

    • queryobject Required

      The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {"boost": 1}}.

      Query DSL