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

« Script APIs Delete stored script API »

› › ›

Create or update stored script API

edit

Create or update stored script API

edit

Creates or updates a stored script or search template.

response = client.put_script(
  id: 'my-stored-script',
  body: {
    script: {
      lang: 'painless',
      source: "Math.log(_score * 2) + params['my_modifier']"
    }
  }
)
puts response

PUT _scripts/my-stored-script
{
  "script": {
    "lang": "painless",
    "source": "Math.log(_score * 2) + params['my_modifier']"
  }
}

Request

edit

PUT _scripts/<script-id>

POST _scripts/<script-id>

PUT _scripts/<script-id>/<context>

POST _scripts/<script-id>/<context>

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. Must be unique within the cluster.
<context>: (Optional, string) Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.

Query parameters

edit

context

(Optional, string) Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.

If you specify both this and the <context> request path parameter, the API uses the request path parameter.

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. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Request body

edit

script

(Required, object) Contains the script or search template, its parameters, and its language.

Properties of script

lang

(Required, string) Script language. For search templates, use mustache.

source

(Required, string or object) For scripts, a string containing the script.

For search templates, an object containing the search template. The object supports the same parameters as the search API's request body. Also supports Mustache variables. See Search templates.

params

(Optional, object) Parameters for the script or search template.

« Script APIs Delete stored script API »