IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create or update stored script API Get script contexts API »

› › ›

Delete stored script API

edit

Delete stored script API

edit

Deletes a stored script or search template.

resp = client.delete_script(
    id="my-stored-script",
)
print(resp)

response = client.delete_script(
  id: 'my-stored-script'
)
puts response

const response = await client.deleteScript({
  id: "my-stored-script",
});
console.log(response);

DELETE _scripts/my-stored-script

Request

edit

DELETE _scripts/<script-id>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API.

Path parameters

edit

<script-id>: (Required, string) Identifier for the stored script or search template.

Query parameters

edit

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
timeout: (Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

« Create or update stored script API Get script contexts API »