Delete a script or search template

Auth

Deletes a stored script or search template.

Required authorization

id string required: The identifier for the stored script or search template.

master_timeout string · default: 30s: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.
timeout string · default: 30s: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

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 _scripts/my-search-template

JavaScript Elasticsearch JavaScript Client

const response = await client.deleteScript({
  id: "my-search-template",
});

Python Elasticsearch Python Client

resp = client.delete_script(
    id="my-search-template",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_scripts/my-search-template" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.deleteScript(d -> d
    .id("my-search-template")
);

C# Elasticsearch .NET Client

var response = await client.DeleteScriptAsync(id: "my-search-template");

PHP Elasticsearch PHP Client

$resp = $client->deleteScript([
    "id" => "my-search-template",
]);

Ruby Elasticsearch Ruby Client

response = client.delete_script(
  id: "my-search-template"
)

Response

{
  "acknowledged": false
}

Generated from the API spec