Delete Forecast APIedit

Deletes forecasts from a machine learning job.

Requestedit

DELETE _xpack/ml/anomaly_detectors/<job_id>/_forecast

DELETE _xpack/ml/anomaly_detectors/<job_id>/_forecast/<forecast_id>

DELETE _xpack/ml/anomaly_detectors/<job_id>/_forecast/_all

Descriptionedit

By default, forecasts are retained for 14 days. You can specify a different retention period with the expires_in parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.

Note

When you delete a job its associated forecasts are deleted.

For more information, see Forecasting the Future.

Path Parametersedit

job_id (required)
(string) Identifier for the job.
forecast_id
(string) A comma-separated list of forecast identifiers. If you do not specify this optional parameter or if you specify _all, the API deletes all forecasts from the job.

Request Parametersedit

allow_no_forecasts
(boolean) Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set to false and there are no forecasts associated with the job, attempts to delete all forecasts return an error. The default value is true.
timeout
(time units) Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API fails and returns an error. The default value is 30s. For more information about time units, see Time unitsedit.

Authorizationedit

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

Examplesedit

The following example deletes all forecasts from the total-requests job:

DELETE _xpack/ml/anomaly_detectors/total-requests/_forecast/_all

If the request does not encounter errors, you receive the following result:

{
  "acknowledged": true
}