elasticsearch/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc
James Rodewig f56a0f4b66
[DOCS] Remove testenv annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00

50 lines
1.2 KiB
Text

[role="xpack"]
[[ml-delete-calendar-job]]
= Delete {anomaly-jobs} from calendar API
++++
<titleabbrev>Delete jobs from calendar</titleabbrev>
++++
Deletes {anomaly-jobs} from a calendar.
[[ml-delete-calendar-job-request]]
== {api-request-title}
`DELETE _ml/calendars/<calendar_id>/jobs/<job_id>`
[[ml-delete-calendar-job-prereqs]]
== {api-prereq-title}
Requires the `manage_ml` cluster privilege. This privilege is included in the
`machine_learning_admin` built-in role.
[[ml-delete-calendar-job-path-parms]]
== {api-path-parms-title}
`<calendar_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
`<job_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
[[ml-delete-calendar-job-example]]
== {api-examples-title}
[source,console]
--------------------------------------------------
DELETE _ml/calendars/planned-outages/jobs/total-requests
--------------------------------------------------
// TEST[skip:setup:calendar_outages_addjob]
When the job is removed from the calendar, you receive the following
results:
[source,console-result]
----
{
"calendar_id": "planned-outages",
"job_ids": []
}
----