Create or update a script or search template

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

Api key auth Basic auth Bearer auth

Creates or updates a stored script or search template.

Required authorization

Cluster privileges: manage

More about searching templates

Path Parameters

Query Parameters

Request

script {} StoredScript required: The script or search template, its parameters, and its language.

Response

application/json

Examples

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

Request Console 1 / 6 languages

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

No example

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST _scripts/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'\'']"
  }
}'

Response

No example

Required authorization

Path Parameters { id , context , }

Query Parameters { context , master_timeout , timeout , }

Request

Response

Path Parameters

Query Parameters