clear-repositories-metering-archive.asciidoc 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  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-api-desc]]
  13. ==== {api-description-title}
  14. You can use this API to clear the archived repositories metering information in the cluster.
  15. [[clear-repositories-metering-archive-api-path-params]]
  16. ==== {api-path-parms-title}
  17. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
  18. `<max_version_to_clear>`::
  19. (long) Specifies the maximum <<get-repositories-metering-api-response-body, archive_version>> to be cleared from the archive.
  20. All the nodes selective options are explained <<cluster-nodes,here>>.
  21. [role="child_attributes"]
  22. [[clear-repositories-metering-archive-api-response-body]]
  23. ==== {api-response-body-title}
  24. Returns the deleted archived repositories metering information.
  25. include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body]