Delete a trained model alias

DELETE /_ml/trained_models/{model_id}/model_aliases/{model_alias}

This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the model_id, this API returns an error.

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

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.deleteTrainedModelAlias({
  model_id: "flight-delay-prediction-1574775339910",
  model_alias: "flight_delay_model",
});

Python Elasticsearch Python Client

resp = client.ml.delete_trained_model_alias(
    model_id="flight-delay-prediction-1574775339910",
    model_alias="flight_delay_model",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteTrainedModelAlias(d -> d
    .modelAlias("flight_delay_model")
    .modelId("flight-delay-prediction-1574775339910")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.DeleteTrainedModelAliasAsync(modelId: "flight-delay-prediction-1574775339910", modelAlias: "flight_delay_model");

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteTrainedModelAlias([
    "model_id" => "flight-delay-prediction-1574775339910",
    "model_alias" => "flight_delay_model",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_trained_model_alias(
  model_id: "flight-delay-prediction-1574775339910",
  model_alias: "flight_delay_model"
)

Response

A successful response when deleting a trained model alias.

{
  "acknowledged": true
}