You're viewing version 2.15 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.

Get stored script

Introduced 1.0

Retrieves a stored script.

Path parameters

Query parameters

Example request

The following retrieves the my-first-script stored script.

GET _scripts/my-first-script

Example response

The GET _scripts/my-first-script request returns the following fields:

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

Response fields

The GET _scripts/my-first-script request returns the following response fields:

Script object