IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Add events to calendar API Close anomaly detection jobs API »
Elastic Docs ›Elasticsearch Guide [8.15] ›REST APIs ›Machine learning anomaly detection APIs

Add anomaly detection jobs to calendar API

edit

Add anomaly detection jobs to calendar API

edit

Adds an anomaly detection job to a calendar.

Request

edit

PUT _ml/calendars/<calendar_id>/jobs/<job_id>

Prerequisites

edit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Path parameters

edit
<calendar_id>
(Required, string) A string that uniquely identifies a calendar.
<job_id>
(Required, string) An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.

Examples

edit
resp = client.ml.put_calendar_job(
    calendar_id="planned-outages",
    job_id="total-requests",
)
print(resp)
response = client.ml.put_calendar_job(
  calendar_id: 'planned-outages',
  job_id: 'total-requests'
)
puts response
const response = await client.ml.putCalendarJob({
  calendar_id: "planned-outages",
  job_id: "total-requests",
});
console.log(response);
PUT _ml/calendars/planned-outages/jobs/total-requests

The API returns the following results:

{
  "calendar_id": "planned-outages",
  "job_ids": [
    "total-requests"
  ]
}
« Add events to calendar API Close anomaly detection jobs API »