IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Machine learning anomaly detection APIs Add anomaly detection jobs to calendar API »
Elastic Docs ›Elasticsearch Guide [7.4] ›REST APIs ›Machine learning anomaly detection APIs

Add events to calendar API

edit

Add events to calendar API

edit

Posts scheduled events in a calendar.

Request

edit

POST _ml/calendars/<calendar_id>/events

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have manage_ml or manage cluster privileges to use this API. See Security privileges.

Description

edit

This API accepts a list of scheduled events, each of which must have a start time, end time, and description.

Path parameters

edit
<calendar_id>
(Required, string) Identifier for the calendar.

Request body

edit
events

(Required, array) A list of one of more scheduled events. The event’s start and end times may be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. An event resource has the following properties:

calendar_id
(Optional, string) An identifier for the calendar that contains the scheduled event.
description
(Optional, string) A description of the scheduled event.
end_time
(Required, date) The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.
start_time
(Required, date) The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.

Examples

edit

You can add scheduled events to the planned-outages calendar as follows:

POST _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"
    }
  ]
}
« Machine learning anomaly detection APIs Add anomaly detection jobs to calendar API »