WARNING: Version 5.6 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get Records API Post Data to Jobs API »

› › ›

Open Jobs API

A job must be opened in order for it to be ready to receive and analyze data. A job can be opened and closed multiple times throughout its lifecycle.

Request

POST _xpack/ml/anomaly_detectors/{job_id}/_open

Description

A job must be open in order to it to accept and analyze data.

When you open a new job, it starts with an empty model.

When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.

Path Parameters

job_id (required): (string) Identifier for the job

Request Body

timeout: (time) Controls the time to wait until a job has opened. The default value is 30 minutes.

Authorization

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

The following example opens the event_rate job and sets an optional property:

POST _xpack/ml/anomaly_detectors/event_rate/_open
{
  "timeout": "35m"
}

When the job opens, you receive the following results:

{
  "opened": true
}

« Get Records API Post Data to Jobs API »