Update datafeeds APIedit

Updates certain properties of a datafeed.

Requestedit

POST _ml/datafeeds/<feed_id>/_update

Prerequisitesedit

  • If Elasticsearch security features are enabled, you must have manage_ml, or manage cluster privileges to use this API. See Security privileges.

Descriptionedit

If you update the delayed_data_check_config property, you must stop and start the datafeed for the change to be applied.

Important

When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of update and runs the query using those same roles.

Path parametersedit

<feed_id>
(Required, string) Identifier for the datafeed.

Request bodyedit

The following properties can be updated after the datafeed is created:

aggregations
(Optional, object) If set, the datafeed performs aggregation searches. For more information, see Datafeed resources.
chunking_config
(Optional, object) Specifies how data searches are split into time chunks. See Chunking configuration objects.
delayed_data_check_config
(Optional, object) Specifies whether the data feed checks for missing data and the size of the window. See Delayed data check configuration objects.
frequency
(Optional, time units) The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: 150s.
indices
(Optional, array) An array of index names. Wildcards are supported. For example: ["it_ops_metrics", "server*"].
job_id
(Optional, string) A numerical character string that uniquely identifies the anomaly detection job.
query
(Optional, object) 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_delay
(Optional, time units) The number of seconds behind real-time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is 60s.
script_fields
(Optional, object) Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. For more information, see Script fields.
scroll_size
(Optional, unsigned integer) The size parameter that is used in Elasticsearch searches. The default value is 1000.

For more information about these properties, see Datafeed resources.

Examplesedit

The following example updates the query for the datafeed-total-requests datafeed so that only log entries of error level are analyzed:

POST _ml/datafeeds/datafeed-total-requests/_update
{
  "query": {
    "term": {
      "level": "error"
    }
  }
}

When the datafeed is updated, you receive the full datafeed configuration with with the updated values:

{
  "datafeed_id": "datafeed-total-requests",
  "job_id": "total-requests",
  "query_delay": "83474ms",
  "indices": ["server-metrics"],
  "query": {
    "term": {
      "level": {
        "value": "error",
        "boost": 1.0
      }
    }
  },
  "scroll_size": 1000,
  "chunking_config": {
    "mode": "auto"
  }
}