Get Stored Script API

Introduced 1.0

Retrieves a stored script from the cluster state.

Endpoints

GET _scripts/my-first-script

Path parameters

Query parameters

Example request

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

GET /_scripts/my-first-script

response = client.get_script(
  id = "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 body fields

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

Script object

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:admin/script/get.