|
1 | 1 | [role="xpack"]
|
2 | 2 | [testenv="platinum"]
|
3 | 3 | [[ml-delete-calendar-job]]
|
4 |
| -=== Delete jobs from calendar API |
| 4 | +=== Delete {anomaly-jobs} from calendar API |
5 | 5 | ++++
|
6 | 6 | <titleabbrev>Delete jobs from calendar</titleabbrev>
|
7 | 7 | ++++
|
8 | 8 |
|
9 |
| -Deletes jobs from a calendar. |
| 9 | +Deletes {anomaly-jobs} from a calendar. |
10 | 10 |
|
11 | 11 | [[ml-delete-calendar-job-request]]
|
12 | 12 | ==== {api-request-title}
|
13 | 13 |
|
14 | 14 | `DELETE _ml/calendars/<calendar_id>/jobs/<job_id>`
|
15 | 15 |
|
16 |
| -[[ml-delete-calendar-job-path-parms]] |
17 |
| -==== {api-path-parms-title} |
18 |
| - |
19 |
| -`calendar_id`(required):: |
20 |
| - (string) Identifier for the calendar. |
21 |
| - |
22 |
| -`job_id` (required):: |
23 |
| - (string) An identifier for the job. It can be a job identifier, a group name, or a |
24 |
| - comma-separated list of jobs or groups. |
25 |
| - |
26 | 16 | [[ml-delete-calendar-job-prereqs]]
|
27 | 17 | ==== {api-prereq-title}
|
28 | 18 |
|
29 |
| -You must have `manage_ml`, or `manage` cluster privileges to use this API. |
| 19 | +* You must have `manage_ml`, or `manage` cluster privileges to use this API. |
30 | 20 | For more information, see {stack-ov}/security-privileges.html[Security privileges].
|
31 | 21 |
|
| 22 | +[[ml-delete-calendar-job-path-parms]] |
| 23 | +==== {api-path-parms-title} |
| 24 | + |
| 25 | +`<calendar_id>`:: |
| 26 | + (Required, string) Identifier for the calendar. |
| 27 | + |
| 28 | +`<job_id>`:: |
| 29 | + (Required, string) An identifier for the {anomaly-jobs}. It can be a job |
| 30 | + identifier, a group name, or a comma-separated list of jobs or groups. |
| 31 | + |
32 | 32 | [[ml-delete-calendar-job-example]]
|
33 | 33 | ==== {api-examples-title}
|
34 | 34 |
|
|
0 commit comments