IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get data frame analytics jobs statistics API Stop data frame analytics jobs API »

› › ›

Start data frame analytics jobs API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

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

You must have machine_learning_admin built-in role to use this API. You must also have read and view_index_metadata privileges on the source index and read, create_index, and index privileges on the destination index. 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) Controls the amount of time to wait until the data frame analytics job starts. The default value is 20 seconds.

Examples

edit

The following example starts the loganalytics data frame analytics job:

POST _ml/data_frame/analytics/loganalytics/_start

Copy as curl Try in Elastic

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

{
  "acknowledged" : true
}

« Get data frame analytics jobs statistics API Stop data frame analytics jobs API »

Was this helpful?

Feedback