CLclouditor
Orchestrator

GET /v1/orchestrator/metrics/{metricId}

Changed on

Returns the metric with the passed metric id

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

metricIdstring required

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.

Changes

  • 97c4541f02f0Revision changes
    • info

      added the required property to the response with the status

  • 48f235df8ac6Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status