You're viewing version 2.5 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Create or update stored script

Creates or updates a stored script or search template.

For additional information about Painless scripting, see:

• k-NN Painless Scripting extensions.

• k-NN.

Path parameters

Query parameters

All parameters are optional.

Request fields

Script object

Example request

The sample uses an index called books with the following documents:

{"index":{"_id":1}}
{"name":"book1","author":"Faustine","ratings":[4,3,5]}
{"index":{"_id":2}}
{"name":"book2","author":"Amit","ratings":[5,5,5]}
{"index":{"_id":3}}
{"name":"book3","author":"Gilroy","ratings":[2,1,5]}

The following request creates the Painless script my-first-script. It sums the ratings for each book and displays the sum in the output.

PUT _scripts/my-first-script
{
  "script": {
      "lang": "painless",
      "source": """
          int total = 0;
          for (int i = 0; i < doc['ratings'].length; ++i) {
            total += doc['ratings'][i];
          }
          return total;
        """
  }
}

The example above uses the syntax of the Dev Tools console in OpenSearch Dashboards. You can also use a curl request.

The following curl request is equivalent to the previous Dashboards console example:

curl -XPUT "http://opensearch:9200/_scripts/my-first-script" -H 'Content-Type: application/json' -d'
{
  "script": {
      "lang": "painless",
      "source": "\n          int total = 0;\n          for (int i = 0; i < doc['\''ratings'\''].length; ++i) {\n            total += doc['\''ratings'\''][i];\n          }\n          return total;\n        "
  }
}'

The following request creates the Painless script my-first-script, which sums the ratings for each book and displays the sum in the output:

PUT _scripts/my-first-script
{
  "script": {
      "lang": "painless",
      "source": """
          int total = 0;
          for (int i = 0; i < doc['ratings'].length; ++i) {
            total += doc['ratings'][i];
          }
          return total;
        """
  }
}

See Execute Painless stored script for information about running the script.

Example response

The PUT _scripts/my-first-script request returns the following field:

{
  "acknowledged" : true
}

To determine whether the script was successfully created, use the Get stored script API, passing the script name as the script path parameter.

Response fields

Creating or updating a stored script with parameters

The Painless script supports params to pass variables to the script.

Example

The following request creates the Painless script multiplier-script. The request sums the ratings for each book, multiplies the summed value by the multiplier parameter, and displays the result in the output:

PUT _scripts/multiplier-script
{
  "script": {
      "lang": "painless",
      "source": """
          int total = 0;
          for (int i = 0; i < doc['ratings'].length; ++i) {
            total += doc['ratings'][i];
          }
          return total * params['multiplier'];
        """
  }
}

Example response

The PUT _scripts/multiplier-script request returns the following field:

{
  "acknowledged" : true
}