Stop a trained model deployment

POST /_ml/trained_models/{model_id}/deployment/_stop

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

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/trained_models/my_model_for_search/deployment/_stop

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.stopTrainedModelDeployment({
  model_id: "my_model_for_search",
});

Python Elasticsearch Python Client

resp = client.ml.stop_trained_model_deployment(
    model_id="my_model_for_search",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/trained_models/my_model_for_search/deployment/_stop" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().stopTrainedModelDeployment(s -> s
    .modelId("my_model_for_search")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.StopTrainedModelDeploymentAsync(modelId: "my_model_for_search");

PHP Elasticsearch PHP Client

$resp = $client->ml()->stopTrainedModelDeployment([
    "model_id" => "my_model_for_search",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.stop_trained_model_deployment(
  model_id: "my_model_for_search"
)

Response

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body