Add scheduled events to the calendar

POST /_ml/calendars/{calendar_id}/events

Auth

Required privileges

Cluster privileges manage_ml

Path parameters

calendar_id string required: A string that uniquely identifies a calendar.

Request body

events object[] required: A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.

Response

application/json

events object[] required

View as Markdown

Examples

Request Console 1 / 8 languages

An example body for a POST _ml/calendars/planned-outages/events request.

Console Kibana Dev Tools

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}
  ]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.postCalendarEvents({
  calendar_id: "planned-outages",
  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,
    },
  ],
});

Python Elasticsearch Python Client

resp = client.ml.post_calendar_events(
    calendar_id="planned-outages",
    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
        }
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/calendars/planned-outages/events" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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
      }
    ]
  }'

Java Elasticsearch Java Client

client.ml().postCalendarEvents(p -> p
    .calendarId("planned-outages")
    .events(List.of(CalendarEvent.of(c -> c
            .description("event 1")
            .endTime(DateTime.ofEpochMilli(1513728000000L))
            .startTime(DateTime.ofEpochMilli(1513641600000L))
        ),CalendarEvent.of(c -> c
            .description("event 2")
            .endTime(DateTime.ofEpochMilli(1513900800000L))
            .startTime(DateTime.ofEpochMilli(1513814400000L))
        ),CalendarEvent.of(c -> c
            .description("event 3")
            .endTime(DateTime.ofEpochMilli(1514246400000L))
            .startTime(DateTime.ofEpochMilli(1514160000000L))
        )))
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .PostCalendarEventsAsync(calendarId: "planned-outages", d1 => d1
        .Events(d2 => d2
            .Description("event 1")
            .EndTime(DateTimeOffset.Parse("2017-12-20T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind))
            .StartTime(DateTimeOffset.Parse("2017-12-19T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind)), d2 => d2
            .Description("event 2")
            .EndTime(DateTimeOffset.Parse("2017-12-22T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind))
            .StartTime(DateTimeOffset.Parse("2017-12-21T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind)), d2 => d2
            .Description("event 3")
            .EndTime(DateTimeOffset.Parse("2017-12-26T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind))
            .StartTime(DateTimeOffset.Parse("2017-12-25T00:00:00.0000000+00:00", CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind))
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->postCalendarEvents([
    "calendar_id" => "planned-outages",
    "body" => [
        "events" => array(
            [
                "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,
            ],
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.post_calendar_events(
  calendar_id: "planned-outages",
  body: {
    "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
      }
    ]
  }
)

Response

{
  "events": [
    {
      "calendar_id": "string",
      "event_id": "string",
      "description": "string",
      "end_time": "string",
      "start_time": "string",
      "skip_result": true,
      "skip_model_update": true,
      "force_time_shift": 0
    }
  ]
}

Generated from the API spec

Required privileges

Path parameters

Request body { }

Response

Request body