GET /v1/orchestrator/metrics/:metricId — orchestrator-api

Orchestrator

Returns the metric with the passed metric id

get/v1/orchestrator/metrics/{metricId}

Path parameters

metricIdstring required

Response

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

Changed in 8 of the 50 revisions of this API.101322

Mar 4, 202697c4541f02f01See the full diff
- ○
  added the required property to the response with the status
  response-required-property-added
Jul 21, 202548f235df8ac6134See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 8, 20252b79660c20a04See the full diff
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property ///// became required for the status
  response-property-became-required
- ○
  the response property ///// became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
Apr 16, 20247ea70d31170c1See the full diff
- ○
  the response's property pattern ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ was added for the status
  response-property-pattern-added
Feb 16, 2024b58167cced1e372See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from integer to string, and format from int64 to no format for status
  response-property-type-changed
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added to the response property allOf list for the response status
  response-property-all-of-added
- ○
  added to the response property allOf list for the response status
  response-property-all-of-added
Nov 29, 2023dc83c7b45e881See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Dec 9, 20224061cf3eaf3711See the full diff
- ●
  added the new LANGUAGE_REGO enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  removed the REGO enum value from the / response property for the response status
  response-property-enum-value-removed
Nov 7, 20229aea46cc4c8a628See the full diff
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  removed from the response property allOf list for the response status
  response-property-all-of-removed
This revision also has 110 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history