OpenSearch/docs/reference/repositories-metering-api/apis/clear-repositories-metering...

36 lines
1.3 KiB
Plaintext

[role="xpack"]
[testenv="basic"]
[[clear-repositories-metering-archive-api]]
=== Clear repositories metering archive
++++
<titleabbrev>Clear repositories metering archive</titleabbrev>
++++
Removes the archived repositories metering information present in the cluster.
[[clear-repositories-metering-archive-api-request]]
==== {api-request-title}
`DELETE /_nodes/<node_id>/_repositories_metering/<max_version_to_clear>`
[[clear-repositories-metering-archive-api-desc]]
==== {api-description-title}
You can use this API to clear the archived repositories metering information in the cluster.
[[clear-repositories-metering-archive-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
`<max_version_to_clear>`::
(long) Specifies the maximum <<get-repositories-metering-api-response-body, archive_version>> to be cleared from the archive.
All the nodes selective options are explained <<cluster-nodes,here>>.
[role="child_attributes"]
[[clear-repositories-metering-archive-api-response-body]]
==== {api-response-body-title}
Returns the deleted archived repositories metering information.
include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body]