Delete a data frame analytics job Generally available; Added in 7.3.0

DELETE /_ml/data_frame/analytics/{id}
Api key auth Basic auth Bearer auth

Required authorization

  • Cluster privileges: manage_ml

Path parameters

  • id string Required

    Identifier for the data frame analytics job.

Query parameters

  • force boolean

    If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.

  • timeout string

    The time to wait for the job to be deleted.

    Values are -1 or 0.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
DELETE /_ml/data_frame/analytics/{id} 
DELETE _ml/data_frame/analytics/loganalytics

resp = client.ml.delete_data_frame_analytics(
    id="loganalytics",
)
const response = await client.ml.deleteDataFrameAnalytics({
  id: "loganalytics",
});
response = client.ml.delete_data_frame_analytics(
  id: "loganalytics"
)
$resp = $client->ml()->deleteDataFrameAnalytics([
    "id" => "loganalytics",
]);
curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics"
Response examples (200)
A successful response when deleting a data frame analytics job. 
{
  "acknowledged": true
}