delete-pipeline.asciidoc 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. [[delete-pipeline-api]]
  2. === Delete pipeline API
  3. ++++
  4. <titleabbrev>Delete pipeline</titleabbrev>
  5. ++++
  6. Deletes one or more existing ingest pipeline.
  7. ////
  8. [source,console]
  9. ----
  10. PUT /_ingest/pipeline/my-pipeline-id
  11. {
  12. "description" : "example pipeline to delete",
  13. "processors" : [ ]
  14. }
  15. PUT /_ingest/pipeline/pipeline-one
  16. {
  17. "description" : "another example pipeline to delete",
  18. "processors" : [ ]
  19. }
  20. ----
  21. // TESTSETUP
  22. ////
  23. [source,console]
  24. ----
  25. DELETE /_ingest/pipeline/my-pipeline-id
  26. ----
  27. [[delete-pipeline-api-request]]
  28. ==== {api-request-title}
  29. `DELETE /_ingest/pipeline/<pipeline>`
  30. [[delete-pipeline-api-prereqs]]
  31. ==== {api-prereq-title}
  32. * If the {es} {security-features} are enabled, you must have the
  33. `manage_pipeline`, `manage_ingest_pipelines`, or `manage`
  34. <<privileges-list-cluster,cluster privilege>> to use this API.
  35. [[delete-pipeline-api-path-params]]
  36. ==== {api-path-parms-title}
  37. `<pipeline>`::
  38. +
  39. --
  40. (Required, string) Pipeline ID or wildcard expression of pipeline IDs
  41. used to limit the request.
  42. To delete all ingest pipelines in a cluster,
  43. use a value of `*`.
  44. --
  45. [[delete-pipeline-api-query-params]]
  46. ==== {api-query-parms-title}
  47. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  48. [[delete-pipeline-api-api-example]]
  49. ==== {api-examples-title}
  50. [[delete-pipeline-api-specific-ex]]
  51. ===== Delete a specific ingest pipeline
  52. [source,console]
  53. ----
  54. DELETE /_ingest/pipeline/pipeline-one
  55. ----
  56. [[delete-pipeline-api-wildcard-ex]]
  57. ===== Delete ingest pipelines using a wildcard expression
  58. [source,console]
  59. ----
  60. DELETE /_ingest/pipeline/pipeline-*
  61. ----
  62. [[delete-pipeline-api-all-ex]]
  63. ===== Delete all ingest pipelines
  64. [source,console]
  65. ----
  66. DELETE /_ingest/pipeline/*
  67. ----
  68. ////
  69. [source,console-result]
  70. ----
  71. {
  72. "acknowledged": true
  73. }
  74. ----
  75. ////