delete-ip-location-database.asciidoc 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. [[delete-ip-location-database-api]]
  2. === Delete IP geolocation database configuration API
  3. ++++
  4. <titleabbrev>Delete IP geolocation database configuration</titleabbrev>
  5. ++++
  6. .New API reference
  7. [sidebar]
  8. --
  9. For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs].
  10. --
  11. Deletes a IP geolocation database configuration.
  12. [source,console]
  13. ----
  14. DELETE /_ingest/ip_location/database/my-database-id
  15. ----
  16. // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.]
  17. [[delete-ip-location-database-api-request]]
  18. ==== {api-request-title}
  19. `DELETE /_ingest/ip_location/database/<database>`
  20. [[delete-ip-location-database-api-prereqs]]
  21. ==== {api-prereq-title}
  22. * If the {es} {security-features} are enabled, you must have the
  23. `manage` <<privileges-list-cluster,cluster privilege>> to use this API.
  24. [[delete-ip-location-database-api-path-params]]
  25. ==== {api-path-parms-title}
  26. `<database>`::
  27. +
  28. --
  29. (Required, string) Database configuration ID used to limit the request.
  30. --
  31. [[delete-ip-location-database-api-query-params]]
  32. ==== {api-query-parms-title}
  33. include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  34. [[delete-ip-location-database-api-example]]
  35. ==== {api-examples-title}
  36. [[delete-ip-location-database-api-specific-ex]]
  37. ===== Delete a specific IP geolocation database configuration
  38. [source,console]
  39. ----
  40. DELETE /_ingest/ip_location/database/example-database-id
  41. ----
  42. // TEST[skip:we don't want to leak the enterprise-geoip-downloader task, which touching these APIs would cause. Therefore, skip this test.]