WARNING: Version 6.2 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
This API enables you to post scheduled events in a calendar.
This API accepts a list of scheduled events, each of which must have a start time, end time, and description.
-
events
- (array) A list of one of more scheduled events. See Scheduled Event Resources.
You must have manage_ml
, or manage
cluster privileges to use this API.
For more information, see
Security Privileges.
You can add scheduled events to the planned-outages
calendar as follows:
POST _xpack/ml/calendars/planned-outages/events { "events" : [ {"description": "event 1", "start_time": 1513641600000, "end_time": 1513728000000}, {"description": "event 2", "start_time": 1513814400000, "end_time": 1513900800000}, {"description": "event 3", "start_time": 1514160000000, "end_time": 1514246400000} ] }
The API returns the following results:
{ "events": [ { "description": "event 1", "start_time": 1513641600000, "end_time": 1513728000000, "calendar_id": "planned-outages" }, { "description": "event 2", "start_time": 1513814400000, "end_time": 1513900800000, "calendar_id": "planned-outages" }, { "description": "event 3", "start_time": 1514160000000, "end_time": 1514246400000, "calendar_id": "planned-outages" } ] }
For more information about these properties, see Scheduled Event Resources.