IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get inference trained model statistics API Stop data frame analytics jobs API »
Elastic Docs ›Elasticsearch Guide [7.6] ›REST APIs ›Machine learning data frame analytics APIs

Start data frame analytics jobs API

edit

Start data frame analytics jobs API

edit

Starts a data frame analytics job.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Request

edit

POST _ml/data_frame/analytics/<data_frame_analytics_id>/_start

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the following built-in roles and privileges:

  • machine_learning_admin
  • kibana_user (UI only)
  • source index: read, view_index_metadata
  • destination index: read, create_index, manage and index
  • cluster: monitor (UI only)

For more information, see Security privileges and Built-in roles.

Path parameters

edit
<data_frame_analytics_id>
(Required, string) Identifier for the data frame analytics job. 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

edit
timeout
(Optional, time units) Controls the amount of time to wait until the data frame analytics job starts. Defaults to 20 seconds.

Examples

edit

The following example starts the loganalytics data frame analytics job:

POST _ml/data_frame/analytics/loganalytics/_start

When the data frame analytics job starts, you receive the following results:

{
  "acknowledged" : true
}
« Get inference trained model statistics API Stop data frame analytics jobs API »