Delete a data frame analytics job

DELETE /_ml/data_frame/analytics/{id}

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/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
}