OpenSearch/docs/en/rest-api/ml/delete-calendar-job.asciidoc

53 lines
1.1 KiB
Plaintext

[role="xpack"]
[[ml-delete-calendar-job]]
=== Delete Jobs from Calendar API
++++
<titleabbrev>Delete Jobs from Calendar</titleabbrev>
++++
This API enables you to delete jobs from a calendar.
==== Request
`DELETE _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.
==== Authorization
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
==== Examples
The following example removes the association between the `planned-outages`
calendar and `total-requests` job:
[source,js]
--------------------------------------------------
DELETE _xpack/ml/calendars/planned-outages/jobs/total-requests
--------------------------------------------------
// CONSOLE
// TEST[setup:calendar_outages_addjob]
When the job is removed from the calendar, you receive the following
results:
[source,js]
----
{
"calendar_id": "planned-outages",
"job_ids": []
}
----
//TESTRESPONSE