1
0

delete-pipeline.asciidoc 2.0 KB

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