2017-12-20 16:52:58 -05:00
|
|
|
[role="xpack"]
|
|
|
|
|
[[ml-put-calendar]]
|
2017-12-20 19:37:19 -05:00
|
|
|
=== Create Calendar API
|
|
|
|
|
++++
|
|
|
|
|
<titleabbrev>Create Calendar</titleabbrev>
|
|
|
|
|
++++
|
2017-12-20 16:52:58 -05:00
|
|
|
|
2018-01-15 11:44:08 -05:00
|
|
|
This API enables you to instantiate a calendar.
|
2017-12-20 16:52:58 -05:00
|
|
|
|
|
|
|
|
==== Request
|
|
|
|
|
|
|
|
|
|
`PUT _xpack/ml/calendars/<calendar_id>`
|
|
|
|
|
|
2018-01-24 11:14:23 -05:00
|
|
|
===== Description
|
|
|
|
|
|
|
|
|
|
For more information, see
|
|
|
|
|
{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events].
|
2017-12-20 16:52:58 -05:00
|
|
|
|
|
|
|
|
==== Path Parameters
|
|
|
|
|
|
|
|
|
|
`calendar_id` (required)::
|
|
|
|
|
(string) Identifier for the calendar.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
==== Request Body
|
|
|
|
|
|
|
|
|
|
`description`::
|
|
|
|
|
(string) A description of the calendar.
|
|
|
|
|
|
2018-01-24 11:14:23 -05:00
|
|
|
|
2017-12-20 16:52:58 -05:00
|
|
|
==== 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].
|
|
|
|
|
|
|
|
|
|
|
2018-01-24 11:14:23 -05:00
|
|
|
==== Examples
|
|
|
|
|
|
|
|
|
|
The following example creates the `planned-outages` calendar:
|
|
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
PUT _xpack/ml/calendars/planned-outages
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
// CONSOLE
|
|
|
|
|
|
|
|
|
|
When the calendar is created, you receive the following results:
|
|
|
|
|
[source,js]
|
|
|
|
|
----
|
|
|
|
|
{
|
|
|
|
|
"calendar_id": "planned-outages",
|
|
|
|
|
"job_ids": []
|
|
|
|
|
}
|
|
|
|
|
----
|
|
|
|
|
//TESTRESPONSE
|
