NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› › ›

Add jobs to calendar API

Adds a job to a calendar.

PUT _xpack/ml/calendars/<calendar_id>/jobs/<job_id>

calendar_id (required): (string) Identifier for the calendar.
job_id (required): (string) An identifier for the job. It can be a job identifier, a group name, or a comma-separated list of jobs or groups.

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

The following example associates the planned-outages calendar with the total-requests job:

PUT _xpack/ml/calendars/planned-outages/jobs/total-requests

The API returns the following results:

{
  "calendar_id": "planned-outages",
  "job_ids": [
    "total-requests"
  ]
}