index.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [[ingest-apis]]
  2. == Ingest APIs
  3. Use ingest APIs to manage tasks and resources related to <<ingest,ingest
  4. pipelines>> and processors.
  5. [discrete]
  6. [[ingest-pipeline-apis]]
  7. === Ingest pipeline APIs
  8. Use the following APIs to create, manage, and test ingest pipelines:
  9. * <<put-pipeline-api>> to create or update a pipeline
  10. * <<get-pipeline-api>> to retrieve a pipeline configuration
  11. * <<delete-pipeline-api>> to delete a pipeline
  12. * <<simulate-pipeline-api>> and <<simulate-ingest-api>> to test ingest pipelines
  13. [discrete]
  14. [[ingest-stat-apis]]
  15. === Stat APIs
  16. Use the following APIs to get statistics about ingest processing:
  17. * <<geoip-stats-api>> to get download statistics for IP geolocation databases used with
  18. the <<geoip-processor,`geoip` processor>>.
  19. [discrete]
  20. [[ingest-geoip-database-apis]]
  21. === Ingest GeoIP Database APIs
  22. preview::["The commercial IP geolocation database download management APIs are in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but this feature is not subject to the support SLA of official GA features."]
  23. Use the following APIs to configure and manage commercial IP geolocation database downloads:
  24. * <<put-geoip-database-api>> to create or update a database configuration
  25. * <<get-geoip-database-api>> to retrieve a database configuration
  26. * <<delete-geoip-database-api>> to delete a database configuration
  27. include::put-pipeline.asciidoc[]
  28. include::get-pipeline.asciidoc[]
  29. include::delete-pipeline.asciidoc[]
  30. include::simulate-pipeline.asciidoc[]
  31. include::simulate-ingest.asciidoc[]
  32. include::geoip-stats.asciidoc[]
  33. include::put-geoip-database.asciidoc[]
  34. include::get-geoip-database.asciidoc[]
  35. include::delete-geoip-database.asciidoc[]