Get stored script API

Get stored script API

New API reference

For the most up-to-date API details, refer to Script APIs.

Retrieves a stored script or search template.

  1. resp = client.get_script(
  2.     id="my-stored-script",
  3. )
  4. print(resp)
  1. response = client.get_script(
  2.   id: 'my-stored-script'
  3. )
  4. puts response
  1. const response = await client.getScript({
  2.   id: "my-stored-script",
  3. });
  4. console.log(response);
  1. GET _scripts/my-stored-script

Request

GET _scripts/<script-id>

Prerequisites

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

Path parameters

<script-id>

(Required, string) Identifier for the stored script or search template.

Query parameters

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.