Delete events from a calendar

Auth

Required privileges

calendar_id string required: A string that uniquely identifies a calendar.
event_id string required: Identifier for the scheduled event. You can obtain this identifier by using the get calendar events API.

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.deleteCalendarEvent({
  calendar_id: "planned-outages",
  event_id: "LS8LJGEBMTCMA-qz49st",
});

Python Elasticsearch Python Client

resp = client.ml.delete_calendar_event(
    calendar_id="planned-outages",
    event_id="LS8LJGEBMTCMA-qz49st",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteCalendarEvent(d -> d
    .calendarId("planned-outages")
    .eventId("LS8LJGEBMTCMA-qz49st")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.DeleteCalendarEventAsync(calendarId: "planned-outages", eventId: "LS8LJGEBMTCMA-qz49st");

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteCalendarEvent([
    "calendar_id" => "planned-outages",
    "event_id" => "LS8LJGEBMTCMA-qz49st",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_calendar_event(
  calendar_id: "planned-outages",
  event_id: "LS8LJGEBMTCMA-qz49st"
)

Response

A successful response when deleting a calendar event.

{
  "acknowledged": true
}