delete-pipeline.asciidoc 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. [role="xpack"]
  2. [[logstash-api-delete-pipeline]]
  3. === Delete {ls} pipeline API
  4. ++++
  5. <titleabbrev>Delete {ls} pipeline</titleabbrev>
  6. ++++
  7. This API deletes a pipeline used for
  8. {logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central
  9. Management].
  10. [[logstash-api-delete-pipeline-request]]
  11. ==== {api-request-title}
  12. `DELETE _logstash/pipeline/<pipeline_id>`
  13. [[logstash-api-delete-pipeline-prereqs]]
  14. ==== {api-prereq-title}
  15. * If the {es} {security-features} are enabled, you must have the
  16. `manage_logstash_pipelines` cluster privilege to use this API.
  17. [[logstash-api-delete-pipeline-desc]]
  18. ==== {api-description-title}
  19. Deletes a {ls} pipeline.
  20. [[logstash-api-delete-pipeline-params]]
  21. ==== {api-path-parms-title}
  22. `<pipeline_id>`::
  23. (Required, string) Identifier for the Pipeline.
  24. [[logstash-api-delete-pipeline-example]]
  25. ==== {api-examples-title}
  26. The following example deletes the Pipeline named `my_pipeline`:
  27. //////////////////////////
  28. [source,console]
  29. --------------------------------------------------
  30. PUT _logstash/pipeline/my_pipeline
  31. {
  32. "description": "Sample Pipeline for illustration purposes",
  33. "last_modified": "2021-01-02T02:50:51.250Z",
  34. "pipeline_metadata": {
  35. "type": "logstash_pipeline",
  36. "version": "1"
  37. },
  38. "username": "elastic",
  39. "pipeline": "input {}\n filter { grok {} }\n output {}",
  40. "pipeline_settings": {
  41. "pipeline.workers": 1,
  42. "pipeline.batch.size": 125,
  43. "pipeline.batch.delay": 50,
  44. "queue.type": "memory",
  45. "queue.max_bytes": "1gb",
  46. "queue.checkpoint.writes": 1024
  47. }
  48. }
  49. --------------------------------------------------
  50. //////////////////////////
  51. [source,console]
  52. --------------------------------------------------
  53. DELETE _logstash/pipeline/my_pipeline
  54. --------------------------------------------------
  55. // TEST[continued]
  56. If the request succeeds, you receive an empty response with an appropriate
  57. status code.