12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 |
- [role="xpack"]
- [testenv="platinum"]
- [[ml-put-calendar-job]]
- === Add Jobs to Calendar API
- ++++
- <titleabbrev>Add Jobs to Calendar</titleabbrev>
- ++++
- Adds a job to a calendar.
- ==== Request
- `PUT _xpack/ml/calendars/<calendar_id>/jobs/<job_id>`
- ==== Path Parameters
- `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.
- ==== Authorization
- You must have `manage_ml`, or `manage` cluster privileges to use this API.
- For more information, see
- {xpack-ref}/security-privileges.html[Security Privileges].
- ==== Examples
- The following example associates the `planned-outages` calendar with the
- `total-requests` job:
- [source,js]
- --------------------------------------------------
- PUT _xpack/ml/calendars/planned-outages/jobs/total-requests
- --------------------------------------------------
- // CONSOLE
- // TEST[skip:setup:calendar_outages_openjob]
- The API returns the following results:
- [source,js]
- ----
- {
- "calendar_id": "planned-outages",
- "job_ids": [
- "total-requests"
- ]
- }
- ----
- // TESTRESPONSE
|