NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Open jobs API
editOpen jobs API
editOpens one or more jobs. 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
editPOST _xpack/ml/anomaly_detectors/{job_id}/_open
Description
editWhen 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
edit-
job_id(required) - (string) Identifier for the job
Request Body
edit-
timeout - (time) Controls the time to wait until a job has opened. The default value is 30 minutes.
Authorization
editYou must have manage_ml, or manage cluster privileges to use this API.
For more information, see
Security privileges.
Examples
editThe following example opens the total-requests job and sets an optional
property:
POST _xpack/ml/anomaly_detectors/total-requests/_open
{
"timeout": "35m"
}
When the job opens, you receive the following results:
{
"opened": true
}