Open anomaly detection jobs

POST /_ml/anomaly_detectors/{job_id}/_open

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 Id required: Identifier for the anomaly detection job.

Query Parameters

timeout string Duration · default: 30m: Controls the time to wait until a job has opened.

Request

timeout string Duration · default: 30m: Refer to the description for the timeout query parameter.

Response

application/json

Examples

A request to open anomaly detection jobs. The timeout specifies to wait 35 minutes for the job to open.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_ml/anomaly_detectors/job-01/_open
{
  "timeout": "35m"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.openJob({
  job_id: "job-01",
  timeout: "35m",
});

Python Elasticsearch Python Client

resp = client.ml.open_job(
    job_id="job-01",
    timeout="35m",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/job-01/_open" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeout": "35m"
  }'

Java Elasticsearch Java Client

client.ml().openJob(o -> o
    .jobId("job-01")
    .timeout(t -> t
        .time("35m")
    )
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .OpenJobAsync(jobId: "job-01", d1 => d1
        .Timeout("35m")
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->openJob([
    "job_id" => "job-01",
    "body" => [
        "timeout" => "35m",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.open_job(
  job_id: "job-01",
  body: {
    "timeout": "35m"
  }
)

Response

{
  "opened": true,
  "node": "node-1"
}