Delete forecasts from a job

Auth

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.

Required authorization

Cluster privileges manage_ml

Path parameters

job_id string required

Identifier for the anomaly detection job.

forecast_id string optional

A comma-separated list of forecast identifiers. If you do not specify this optional parameter or if you specify _all or * the API deletes all forecasts from the job.

Leave it out to use /_ml/anomaly_detectors/{job_id}/_forecast.

Query parameters

allow_no_forecasts boolean · default: true

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.

timeout string · default: 30s

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.

Response

application/json
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.