mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
57 lines
1.2 KiB
Text
57 lines
1.2 KiB
Text
[role="xpack"]
|
|
[[ml-put-calendar]]
|
|
= Create calendars API
|
|
++++
|
|
<titleabbrev>Create calendars</titleabbrev>
|
|
++++
|
|
|
|
Instantiates a calendar.
|
|
|
|
[[ml-put-calendar-request]]
|
|
== {api-request-title}
|
|
|
|
`PUT _ml/calendars/<calendar_id>`
|
|
|
|
[[ml-put-calendar-prereqs]]
|
|
== {api-prereq-title}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
[[ml-put-calendar-desc]]
|
|
== {api-description-title}
|
|
|
|
For more information, see
|
|
{ml-docs}/ml-ad-run-jobs.html#ml-ad-calendars[Calendars and scheduled events].
|
|
|
|
[[ml-put-calendar-path-parms]]
|
|
== {api-path-parms-title}
|
|
|
|
`<calendar_id>`::
|
|
(Required, string)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
|
|
|
[[ml-put-calendar-request-body]]
|
|
== {api-request-body-title}
|
|
|
|
`description`::
|
|
(Optional, string) A description of the calendar.
|
|
|
|
[[ml-put-calendar-example]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ml/calendars/planned-outages
|
|
--------------------------------------------------
|
|
// TEST[skip:need-license]
|
|
|
|
When the calendar is created, you receive the following results:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"calendar_id": "planned-outages",
|
|
"job_ids": []
|
|
}
|
|
----
|