index.asciidoc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. [[ingest-apis]]
  2. == Ingest APIs
  3. .New API reference
  4. [sidebar]
  5. --
  6. For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs].
  7. --
  8. Use ingest APIs to manage tasks and resources related to <<ingest,ingest
  9. pipelines>> and processors.
  10. [discrete]
  11. [[ingest-pipeline-apis]]
  12. === Ingest pipeline APIs
  13. Use the following APIs to create, manage, and test ingest pipelines:
  14. * <<put-pipeline-api>> to create or update a pipeline
  15. * <<get-pipeline-api>> to retrieve a pipeline configuration
  16. * <<delete-pipeline-api>> to delete a pipeline
  17. * <<simulate-pipeline-api>> and <<simulate-ingest-api>> to test ingest pipelines
  18. [discrete]
  19. [[ingest-stat-apis]]
  20. === Stat APIs
  21. Use the following APIs to get statistics about ingest processing:
  22. * <<geoip-stats-api>> to get download statistics for IP geolocation databases used with
  23. the <<geoip-processor,`geoip` processor>>.
  24. [discrete]
  25. [[ingest-ip-location-database-apis]]
  26. === Ingest IP Location Database APIs
  27. Use the following APIs to configure and manage commercial IP geolocation database downloads:
  28. * <<put-ip-location-database-api>> to create or update a database configuration
  29. * <<get-ip-location-database-api>> to retrieve a database configuration
  30. * <<delete-ip-location-database-api>> to delete a database configuration
  31. include::put-pipeline.asciidoc[]
  32. include::get-pipeline.asciidoc[]
  33. include::delete-pipeline.asciidoc[]
  34. include::simulate-pipeline.asciidoc[]
  35. include::simulate-ingest.asciidoc[]
  36. include::geoip-stats.asciidoc[]
  37. include::put-ip-location-database.asciidoc[]
  38. include::get-ip-location-database.asciidoc[]
  39. include::delete-ip-location-database.asciidoc[]