Create or update a script or search template

POST also PUT /_scripts/{id}/{context}
POST also PUT /_scripts/{id}

Auth

Creates or updates a stored script or search template.

Read the reference documentation

Required privileges

Cluster privileges manage

Path parameters

id string required

The identifier for the stored script or search template. It must be unique within the cluster.

context string optional

The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.

Leave it out to use /_scripts/{id}.

Query parameters

context string: The 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> path parameter, the API uses the request path parameter.
master_timeout union oneOf · default: 30s: The period to wait for a connection to the master node. If no response is received 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
timeout union oneOf · default: 30s: The period to wait for a response. If no response is received 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

Request body

script object required: The script or search template, its parameters, and its language.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 6 languages

Run POST _scripts/my-search-template to create a search template.

Console Kibana Dev Tools

POST _scripts/my-search-template
{
  "script": {
    "lang": "mustache",
    "source": {
      "query": {
        "match": {
          "message": "{{query_string}}"
        }
      },
      "from": "{{from}}",
      "size": "{{size}}"
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.putScript({
  id: "my-search-template",
  script: {
    lang: "mustache",
    source: {
      query: {
        match: {
          message: "{{query_string}}",
        },
      },
      from: "{{from}}",
      size: "{{size}}",
    },
  },
});

Python Elasticsearch Python Client

resp = client.put_script(
    id="my-search-template",
    script={
        "lang": "mustache",
        "source": {
            "query": {
                "match": {
                    "message": "{{query_string}}"
                }
            },
            "from": "{{from}}",
            "size": "{{size}}"
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_scripts/my-search-template" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "script": {
      "lang": "mustache",
      "source": {
        "query": {
          "match": {
            "message": "{{query_string}}"
          }
        },
        "from": "{{from}}",
        "size": "{{size}}"
      }
    }
  }'

PHP Elasticsearch PHP Client

$resp = $client->putScript([
    "id" => "my-search-template",
    "body" => [
        "script" => [
            "lang" => "mustache",
            "source" => [
                "query" => [
                    "match" => [
                        "message" => "{{query_string}}",
                    ],
                ],
                "from" => "{{from}}",
                "size" => "{{size}}",
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.put_script(
  id: "my-search-template",
  body: {
    "script": {
      "lang": "mustache",
      "source": {
        "query": {
          "match": {
            "message": "{{query_string}}"
          }
        },
        "from": "{{from}}",
        "size": "{{size}}"
      }
    }
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec

Request Console 1 / 8 languages

Run POST _scripts/my-stored-script to create a stored script.

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_scripts/my-stored-script" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"script":{"lang":"painless","source":"Math.log(_score * 2) + params[' \
  "'" \
  'my_modifier' \
  "'" \
  ']"}}'

Java Elasticsearch Java Client

client.putScript(p -> p
    .id("my-stored-script")
    .script(s -> s
        .lang("painless")
        .source(so -> so
            .scriptString("Math.log(_score * 2) + params['my_modifier']")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client
    .PutScriptAsync(new PutScriptRequest()
    {
        Id = "my-stored-script",
        Script = new()
        {
            Language = ScriptLanguage.Painless,
            Source = "Math.log(_score * 2) + params['my_modifier']"
        }
    });

PHP Elasticsearch PHP Client

$resp = $client->putScript([
    "id" => "my-stored-script",
    "body" => [
        "script" => [
            "lang" => "painless",
            "source" => "Math.log(_score * 2) + params['my_modifier']",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

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

Response

{
  "acknowledged": false
}

Generated from the API spec