delete-pipeline.asciidoc 1.9 KB

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