Open anomaly detection jobs Generally available

POST /_ml/anomaly_detectors/{job_id}/_open
Api key auth

An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. 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.

Required authorization

  • Cluster privileges: manage_ml

Path parameters

  • job_id string Required

    Identifier for the anomaly detection job.

Query parameters

  • timeout string

    Controls the time to wait until a job has opened.

    Values are -1 or 0.

application/json

Body

  • timeout string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • opened boolean Required
    • node string Required
POST /_ml/anomaly_detectors/{job_id}/_open 
POST /_ml/anomaly_detectors/job-01/_open
{
  "timeout": "35m"
}
resp = client.ml.open_job(
    job_id="job-01",
    timeout="35m",
)
const response = await client.ml.openJob({
  job_id: "job-01",
  timeout: "35m",
});
response = client.ml.open_job(
  job_id: "job-01",
  body: {
    "timeout": "35m"
  }
)
$resp = $client->ml()->openJob([
    "job_id" => "job-01",
    "body" => [
        "timeout" => "35m",
    ],
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"timeout":"35m"}' "$ELASTICSEARCH_URL/_ml/anomaly_detectors/job-01/_open"
client.ml().openJob(o -> o
    .jobId("job-01")
    .timeout(t -> t
        .time("35m")
    )
);
Request example
A request to open anomaly detection jobs. The timeout specifies to wait 35 minutes for the job to open. 
{
  "timeout": "35m"
}
Response examples (200)
A successful response when opening an anomaly detection job. 
{
  "opened": true,
  "node": "node-1"
}