delete-pipeline.asciidoc 1.8 KB

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