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.

« Add Events to Calendar API Close Jobs API »

› › ›

Add Jobs to Calendar API

This API enables you to add a job to a calendar.

Request

PUT _xpack/ml/calendars/<calendar_id>/jobs/<job_id>

Path Parameters

calendar_id (required): (string) Identifier for the calendar.
job_id (required): (string) Identifier for the job or job group.

Authorization

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

The following example associates the planned-outages calendar with the total-requests job:

PUT _xpack/ml/calendars/planned-outages/jobs/total-requests

The API returns the following results:

{
  "calendar_id": "planned-outages",
  "job_ids": [
    "total-requests"
  ]
}

« Add Events to Calendar API Close Jobs API »