delete-pipeline.asciidoc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  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-path-params]]
  31. ==== {api-path-parms-title}
  32. `<pipeline>`::
  33. +
  34. --
  35. (Required, string) Pipeline ID or wildcard expression of pipeline IDs
  36. used to limit the request.
  37. To delete all ingest pipelines in a cluster,
  38. use a value of `*`.
  39. --
  40. [[delete-pipeline-api-query-params]]
  41. ==== {api-query-parms-title}
  42. include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  43. [[delete-pipeline-api-api-example]]
  44. ==== {api-examples-title}
  45. [[delete-pipeline-api-specific-ex]]
  46. ===== Delete a specific ingest pipeline
  47. [source,console]
  48. ----
  49. DELETE /_ingest/pipeline/pipeline-one
  50. ----
  51. [[delete-pipeline-api-wildcard-ex]]
  52. ===== Delete ingest pipelines using a wildcard expression
  53. [source,console]
  54. ----
  55. DELETE /_ingest/pipeline/pipeline-*
  56. ----
  57. [[delete-pipeline-api-all-ex]]
  58. ===== Delete all ingest pipelines
  59. [source,console]
  60. ----
  61. DELETE /_ingest/pipeline/*
  62. ----
  63. ////
  64. [source,console-result]
  65. ----
  66. {
  67. "acknowledged": true
  68. }
  69. ----
  70. ////