v1

latestOpenAPI 3.0.32026-07-1746132210.7 KB
Orchestrator

Updates an existing metric

put/v1/orchestrator/metrics/{metric.id}

Path parameters

metric.idstring required

Request body

idstring required

Required. The unique identifier of the metric.

namestring required

Required. The name of the metric.

descriptionstring required

The description of the metric

versionstring required

The version of this metric

commentsstring

Optional comments that describe the purpose of this metric. They may also describe a scenario in which the metric can be useful.

categorystring required

Semantically, the reference to control catalog category or domain; it must conform to the directory structure of the security-metrics respository

deprecatedSincestring date-time

Optional, but required if the metric is removed. The metric is not deleted for backward compatibility and the timestamp is set to the time of removal.

Response

OK

idstring required

Required. The unique identifier of the metric.

namestring required

Required. The name of the metric.

descriptionstring required

The description of the metric

versionstring required

The version of this metric

commentsstring

Optional comments that describe the purpose of this metric. They may also describe a scenario in which the metric can be useful.

categorystring required

Semantically, the reference to control catalog category or domain; it must conform to the directory structure of the security-metrics respository

deprecatedSincestring date-time

Optional, but required if the metric is removed. The metric is not deleted for backward compatibility and the timestamp is set to the time of removal.