Create or update a script or search template | Elasticsearch API (v8)

Create or update a script or search template

PUT /_scripts/{id}/{context}

Creates or updates a stored script or search template.

Path parameters

id string Required

Identifier for the stored script or search template. Must be unique within the cluster.
context string Required

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

Query parameters

master_timeout string

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.
timeout string

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

application/json

Body Required

script object Required

Additional properties are allowed.
Hide script attributes Show script attributes object
- lang string Required
  
  Any of:
  _types:ScriptLanguage string _types:ScriptLanguage string
  
  Values are painless, expression, mustache, or java.
- options object
  Hide options attribute Show options attribute object
  
  * string Additional properties
- source string Required
  
  The script source.

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.

PUT /_scripts/{id}/{context}

curl \
 -X PUT http://api.example.com/_scripts/{id}/{context} \
 -H "Content-Type: application/json" \
 -d '{"script":{"":"painless","options":{"additionalProperty1":"string","additionalProperty2":"string"},"source":"string"}}'

Request examples

{
  "script": {
    "": "painless",
    "options": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "source": "string"
  }
}

Response examples (200)

{
  "acknowledged": true
}