Delete a data frame analytics job

Auth

Required privileges

force boolean · default: false: If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.
timeout union oneOf · default: 1m: The time to wait for the job to be deleted.; Values: -1 0

application/json

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

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/data_frame/analytics/loganalytics

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.deleteDataFrameAnalytics({
  id: "loganalytics",
});

Python Elasticsearch Python Client

resp = client.ml.delete_data_frame_analytics(
    id="loganalytics",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/data_frame/analytics/loganalytics" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteDataFrameAnalytics(d -> d
    .id("loganalytics")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.DeleteDataFrameAnalyticsAsync(id: "loganalytics");

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteDataFrameAnalytics([
    "id" => "loganalytics",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_data_frame_analytics(
  id: "loganalytics"
)

Response

A successful response when deleting a data frame analytics job.

{
  "acknowledged": true
}