delete-stored-script-api.asciidoc 1013 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. [[delete-stored-script-api]]
  2. === Delete stored script API
  3. ++++
  4. <titleabbrev>Delete stored script</titleabbrev>
  5. ++++
  6. Deletes a <<script-stored-scripts,stored script>> or <<search-template,search
  7. template>>.
  8. ////
  9. [source,console]
  10. ----
  11. PUT _scripts/my-stored-script
  12. {
  13. "script": {
  14. "lang": "painless",
  15. "source": """
  16. TimestampHour date = doc['@timestamp'].value;
  17. return date.getHour()
  18. """
  19. }
  20. }
  21. ----
  22. ////
  23. [source,console]
  24. ----
  25. DELETE _scripts/my-stored-script
  26. ----
  27. // TEST[continued]
  28. [[delete-stored-script-api-prereqs]]
  29. ==== {api-prereq-title}
  30. * If the {es} {security-features} are enabled, you must have the `manage`
  31. <<privileges-list-cluster,cluster privilege>> to use this API.
  32. [[delete-stored-script-api-path-params]]
  33. ==== {api-path-parms-title}
  34. `<script-id>`::
  35. (Required, string)
  36. Identifier for the stored script or search template.
  37. [[delete-stored-script-api-query-params]]
  38. ==== {api-query-parms-title}
  39. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]