Delete forecasts from a job

DELETE /_ml/anomaly_detectors/{job_id}/_forecast/{forecast_id}
DELETE /_ml/anomaly_detectors/{job_id}/_forecast

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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/anomaly_detectors/total-requests/_forecast/_all

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.deleteForecast({
  job_id: "total-requests",
  forecast_id: "_all",
});

Python Elasticsearch Python Client

resp = client.ml.delete_forecast(
    job_id="total-requests",
    forecast_id="_all",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/anomaly_detectors/total-requests/_forecast/_all" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteForecast(d -> d
    .forecastId("_all")
    .jobId("total-requests")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .DeleteForecastAsync(new DeleteForecastRequest()
    {
        ForecastId = "_all",
        JobId = "total-requests"
    });

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteForecast([
    "job_id" => "total-requests",
    "forecast_id" => "_all",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_forecast(
  job_id: "total-requests",
  forecast_id: "_all"
)

Response

A successful response when deleting a forecast from an anomaly detection job.

{
  "acknowledged": true
}