Get a script or search template

GET /_scripts/{id}

Auth

Retrieves a stored script or search template.

Required privileges

Cluster privileges manage

Path parameters

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

Query parameters

master_timeout union oneOf · default: 30s: The 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. It can also be set to -1 to indicate that the request should never timeout.; Values: -1 0

Response

application/json

_id string required
found boolean required
script object

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _scripts/my-search-template

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.getScript(g -> g
    .id("my-search-template")
);

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
  "_id": "string",
  "found": false,
  "script": {
    "lang": "painless",
    "options": {
      "key": "string"
    },
    "source": "string"
  }
}

Generated from the API spec