clear-repositories-metering-archive.asciidoc 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[clear-repositories-metering-archive-api]]
  4. === Clear repositories metering archive
  5. ++++
  6. <titleabbrev>Clear repositories metering archive</titleabbrev>
  7. ++++
  8. Removes the archived repositories metering information present in the cluster.
  9. [[clear-repositories-metering-archive-api-request]]
  10. ==== {api-request-title}
  11. `DELETE /_nodes/<node_id>/_repositories_metering/<max_version_to_clear>`
  12. [[clear-repositories-metering-archive-ap-prereqs]]
  13. ==== {api-prereq-title}
  14. * If the {es} {security-features} are enabled, you must have the `monitor` or
  15. `manage` <<privileges-list-cluster,cluster privilege>> to use this API.
  16. [[clear-repositories-metering-archive-api-desc]]
  17. ==== {api-description-title}
  18. You can use this API to clear the archived repositories metering information in the cluster.
  19. [[clear-repositories-metering-archive-api-path-params]]
  20. ==== {api-path-parms-title}
  21. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
  22. `<max_version_to_clear>`::
  23. (long) Specifies the maximum <<get-repositories-metering-api-response-body, archive_version>> to be cleared from the archive.
  24. All the nodes selective options are explained <<cluster-nodes,here>>.
  25. [role="child_attributes"]
  26. [[clear-repositories-metering-archive-api-response-body]]
  27. ==== {api-response-body-title}
  28. Returns the deleted archived repositories metering information.
  29. include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body]